Update template_update.yml

Author: varndellwagglebee

.github/workflows/template_update.yml

@@ -1,3 +1,4 @@
+# .github/workflows/Template_Update.yml
 name: Template_Update
 
 permissions:
@@ -21,6 +22,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+    # ─────────────────────────── Setup ───────────────────────────
     - name: Checkout project repo
       uses: actions/checkout@v4
       with:
@@ -36,111 +38,104 @@ jobs:
     - name: Install dependencies
       run: pip install cookiecutter jq
 
+    # ───────────── Read old SHA & compare with template HEAD ─────────────
     - name: Read old template SHA
-      id: get_old_sha
+      id: old_sha
       run: |
-        OLD_SHA=$(jq -r '.cookiecutter.template_sha // empty' .cookiecutter.json)
-        if [ -z "$OLD_SHA" ]; then
+        SHA=$(jq -r '.cookiecutter.template_sha // empty' .cookiecutter.json)
+        if [ -z "$SHA" ]; then
           echo "::error ::.cookiecutter.json is missing cookiecutter.template_sha"
           exit 1
         fi
-        echo "old_sha=$OLD_SHA" >> "$GITHUB_OUTPUT"
+        echo "sha=$SHA" >> "$GITHUB_OUTPUT"
 
     - name: Fetch new template SHA
-      id: get_new_sha
+      id: new_sha
       run: |
-        NEW_SHA=$(git ls-remote "${{ inputs.template_repo }}" HEAD | cut -f1)
-        echo "new_sha=$NEW_SHA" >> "$GITHUB_OUTPUT"
+        echo "sha=$(git ls-remote '${{ inputs.template_repo }}' HEAD | cut -f1)" >> "$GITHUB_OUTPUT"
 
-    - name: Determine if SHA changed
+    - name: Decide whether to continue
       run: |
-        if [ "${{ steps.get_old_sha.outputs.old_sha }}" != "${{ steps.get_new_sha.outputs.new_sha }}" ]; then
-          echo "SHA_CHANGED=true"  >> "$GITHUB_ENV"
-        else
+        if [ "${{ steps.old_sha.outputs.sha }}" = "${{ steps.new_sha.outputs.sha }}" ]; then
           echo "SHA_CHANGED=false" >> "$GITHUB_ENV"
+        else
+          echo "SHA_CHANGED=true"  >> "$GITHUB_ENV"
         fi
 
-    - name: Exit early if no change
+    - name: Exit if SHA unchanged
       if: env.SHA_CHANGED == 'false'
       run: echo "✂️  SHA unchanged; nothing to update."
 
-    # ────────── Clone template repo (old & new) ──────────
+    # ───────────────── Clone template repo at both SHAs ─────────────────
     - name: Clone template at OLD SHA
       if: env.SHA_CHANGED == 'true'
       run: |
-        git clone "${{ inputs.template_repo }}" base-template
-        git -C base-template checkout "${{ steps.get_old_sha.outputs.old_sha }}"
+        git clone '${{ inputs.template_repo }}' base-template
+        git -C base-template checkout '${{ steps.old_sha.outputs.sha }}'
 
-    - name: Clone template at NEW SHA (HEAD)
+    - name: Clone template at NEW SHA
       if: env.SHA_CHANGED == 'true'
-      run: git clone "${{ inputs.template_repo }}" template-source
+      run: git clone '${{ inputs.template_repo }}' template-source
 
-    - name: Generate BASE template output (OLD SHA)
+    # ────────────────────── Render OLD template ──────────────────────
+    - name: Render OLD template (base-template → template-base)
       if: env.SHA_CHANGED == 'true'
       run: |
         rm -rf ~/.cookiecutters/*
         mkdir -p template-base
-
-        # Uncomment the next two lines only if you still need to inject
-        # a missing variable into the replay file:
-        # jq '.cookiecutter.templates = "main"' .cookiecutter.json > tmp && mv tmp .cookiecutter.json
-
+        # jq '.cookiecutter.templates = "main"' .cookiecutter.json > tmp && mv tmp .cookiecutter.json   # <-- uncomment if keeping the variable
         cookiecutter base-template \
           --replay-file .cookiecutter.json \
           --overwrite-if-exists \
           --output-dir template-base
 
-    - name: Generate NEW template output (HEAD)
+    # ────────────────────── Render NEW template ──────────────────────
+    - name: Render NEW template (template-source → template-new)
       if: env.SHA_CHANGED == 'true'
       run: |
         rm -rf ~/.cookiecutters/*
         mkdir -p template-new
-
+        # jq '.cookiecutter.templates = "main"' .cookiecutter.json > tmp && mv tmp .cookiecutter.json   # <-- same note
         cookiecutter template-source \
           --replay-file .cookiecutter.json \
           --overwrite-if-exists \
           --output-dir template-new
 
-    - name: Apply patch if changes & create PR
+    # ───────────── diff, merge, bump SHA, push branch, open PR ─────────────
+    - name: Apply patch & raise PR
       if: env.SHA_CHANGED == 'true'
       shell: bash
       run: |
-        # Create unified diff between old and new renders
         diff -ruN template-base template-new > update.patch || true
 
         if [ ! -s update.patch ]; then
           echo "ℹ️  No template diffs; only SHA bump will occur."
         else
-          # Try a three-way merge; abort on conflicts
           if ! git apply --index --3way update.patch; then
             echo "::error ::Merge conflicts detected; aborting."
             exit 1
           fi
           echo "✅ Applied template changes"
         fi
 
-        # Bump the recorded SHA in .cookiecutter.json
-        jq ".cookiecutter.template_sha = \"${{ steps.get_new_sha.outputs.new_sha }}\"" \
+        jq ".cookiecutter.template_sha = \"${{ steps.new_sha.outputs.sha }}\"" \
           .cookiecutter.json > tmp && mv tmp .cookiecutter.json
         git add .cookiecutter.json
 
-        UPDATE_BRANCH="template-update-${{ steps.get_new_sha.outputs.new_sha }}"
-        echo "UPDATE_BRANCH=$UPDATE_BRANCH" >> "$GITHUB_ENV"
-
-        # Commit and push
-        git checkout -b "$UPDATE_BRANCH"
+        BRANCH="template-update-${{ steps.new_sha.outputs.sha }}"
+        git checkout -b "$BRANCH"
         git config user.name  "GitHub Actions Bot"
         git config user.email "actions@github.com"
-        git commit -am "chore: merge template updates ${{ steps.get_old_sha.outputs.old_sha }} → ${{ steps.get_new_sha.outputs.new_sha }}"
-        git push origin "$UPDATE_BRANCH"
+        git commit -am "chore: merge template updates ${{ steps.old_sha.outputs.sha }} → ${{ steps.new_sha.outputs.sha }}"
+        git push origin "$BRANCH"
 
-    - name: Create Pull Request
+    - name: Create pull request
       if: env.SHA_CHANGED == 'true'
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: |
         gh pr create \
-          --title "chore: merge template updates ${{ steps.get_old_sha.outputs.old_sha }} → ${{ steps.get_new_sha.outputs.new_sha }}" \
-          --body  "Updates cookiecutter.template_sha from ${{ steps.get_old_sha.outputs.old_sha }} to ${{ steps.get_new_sha.outputs.new_sha }}" \
-          --base  "${{ inputs.repo_branch }}" \
-          --head  "$UPDATE_BRANCH"
+          --title "chore: merge template updates ${{ steps.old_sha.outputs.sha }} → ${{ steps.new_sha.outputs.sha }}" \
+          --body  "Updates cookiecutter.template_sha from ${{ steps.old_sha.outputs.sha }} to ${{ steps.new_sha.outputs.sha }}" \
+          --base  '${{ inputs.repo_branch }}' \
+          --head  "$BRANCH"