From 1e5caad294f3270c4b92f4af4e78b558c389f35b Mon Sep 17 00:00:00 2001
From: David Eisinger <david.eisinger@gmail.com>
Date: Mon, 9 Dec 2024 05:57:05 -0500
Subject: [PATCH] Comment build config

---
 .build.yml | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/.build.yml b/.build.yml
index fc46484..8643606 100644
--- a/.build.yml
+++ b/.build.yml
@@ -17,29 +17,40 @@ triggers:
 environment:
   HUGO_VERSION: 0.139.3
 tasks:
+  # Install Hugo + Bundler, and make all subsequent steps cd into site root
   - setup: |
       wget --quiet https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb
       sudo apt install -y ./hugo_extended_${HUGO_VERSION}_linux-amd64.deb
       sudo gem install bundler
       echo 'cd davideisinger.com' >> ~/.buildenv
+
+  # Spellcheck Markdown files
   - spelling: |
       npx cspell "content/**/*.md"
+
+  # Diff RSS template against Hugo default, make sure only differences are intentional
   - rss: |
       curl -s https://raw.githubusercontent.com/gohugoio/hugo/refs/tags/v$HUGO_VERSION/tpl/tplimpl/embedded/templates/_default/rss.xml \
         | diff - ./themes/v2/layouts/_default/rss.xml \
         | wc -l \
         | grep 7
+
+  # Start Ruby server for dithering images
   - dither: |
       cd bin/dither
       sudo bundle install
       ROOT=~/davideisinger.com/content \
         KEY=~/secret.key \
         bundle exec rackup -p 4567 -D
+
+  # Build site
   - hugo: |
       HUGO_PARAMS_GIT_COMMIT=$(git rev-parse HEAD) \
         DITHER_SERVER=http://localhost:4567 \
         hugo --minify
       find public -name "*.enc" -type f -delete
+
+  # Sync files to production server
   - deploy: |
       if [ "$(git rev-parse main)" != "$(git rev-parse HEAD)" ]; then \
         complete-build; \