From b9f8ae926683e477c0ce9cf820ad13c6c55d3ad4 Mon Sep 17 00:00:00 2001
From: Chris Grieser <73286100+chrisgrieser@users.noreply.github.com>
Date: Sun, 11 Aug 2024 13:34:32 +0200
Subject: [PATCH] ci: better comments in github actions

---
 .github/workflows/build-and-bump.yml | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/build-and-bump.yml b/.github/workflows/build-and-bump.yml
index e520a2bc..2c5e920e 100644
--- a/.github/workflows/build-and-bump.yml
+++ b/.github/workflows/build-and-bump.yml
@@ -2,8 +2,8 @@ name: Build, bump version numbers, and update changelog
 
 on:
   push:
-    branches: [main] # not on insider release branch
-    paths: [source/**] # only for build for source files
+    paths: [source/**] # only trigger action when source files were changed
+    branches: [main] # do not trigger on other the insider-release branch
   workflow_dispatch: # allows manually triggering on github
 
 permissions:
@@ -17,7 +17,7 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        # by default, no tags and only a single commit is fetched. To use git
+        # By default, no tags and only a single commit is fetched. To use git
         # history in the changelog step, we need to fetch all history.
         with:
           fetch-depth: 0 # 0 = all history
@@ -27,6 +27,9 @@ jobs:
 
       - name: Build
         run: |
+          # Due to globbing, the source files are inserted in alphabetical order.
+          # To keep things predictable, they are simply number in the order they
+          # should be included in.
           cat ./source/*.css <(echo "/* @settings") ./source/style-settings.yaml <(echo "*/") \
             > ./theme.css