Merge pull request #3 from Howard-nolan/feature/tweak_github_workflow

Tweak GitHub Merge Workflow

Author: Howard-nolan

.github/pull_request_template.md

@@ -1,14 +1,8 @@
-## Summary
-<!-- What this PR does in one paragraph -->
+## Change Summary:
+<!-- What changed and why (1–3 bullets or a short paragraph) -->
 
-## What I Learned
-- Why: <concept you clarified>
-- How: <the trick/approach that worked>
-- Gotcha: <pitfall you hit and fix>
-- Next time: <how you'll do it better>
+## How It Works:
+<!-- Briefly describe the approach/flow. Mention endpoints, data flow, key structs, retries, etc. -->
 
-## Demo / Evidence
-- curl/ screenshots / logs
-
-## Follow-ups
-- [ ] Small TODOs for later
+## Additional Notes (optional):
+<!-- Edge cases, tradeoffs, follow-ups, links to logs/metrics, screenshots -->

.github/workflows/append-learnings.yml

@@ -2,32 +2,64 @@ name: Append Learnings
 on:
   pull_request:
     types: [closed]
+
 jobs:
   append:
     if: github.event.pull_request.merged == true
     runs-on: ubuntu-latest
     permissions:
       contents: write
       pull-requests: read
+
     steps:
       - uses: actions/checkout@v4
-      - name: Extract learning from PR body
-        id: extract
+
+      - name: Build learnings entry from PR body
+        id: build
         uses: actions/github-script@v7
         with:
           script: |
-            const body = context.payload.pull_request.body || "";
-            // Grab the section under "## What I Learned"
-            const match = body.match(/## What I Learned([\s\S]*?)(## |\Z)/);
-            const learned = match ? match[1].trim() : "";
-            core.setOutput("learned", learned);
-      - name: Update LEARNINGS.md
-        if: steps.extract.outputs.learned != ''
+            // Helpers
+            function section(name, body) {
+              // Match "## Name:" OR "Name:" (case-insensitive), capture until blank line or end
+              const re = new RegExp(`(?:^|\\n)##?\\s*${name}\\s*:\\s*([\\s\\S]*?)(?:\\n\\s*\\n|$)`, 'i');
+              const m = body.match(re);
+              return m ? m[1].trim() : '';
+            }
+            function mdClean(s) {
+              // Normalize Windows newlines, trim trailing spaces
+              return s.replace(/\r/g, '').trim();
+            }
+
+            const pr = context.payload.pull_request;
+            const body = pr.body || '';
+
+            const changeSummary = mdClean(section('Change Summary', body));
+            const howItWorks   = mdClean(section('How It Works', body));
+            const notes        = mdClean(section('Additional Notes', body));
+
+            // If everything is empty, do nothing
+            if (!changeSummary && !howItWorks && !notes) {
+              core.setOutput('should_update', 'false');
+              return;
+            }
+
+            const today = new Date().toISOString().slice(0,10); // YYYY-MM-DD
+            const header = `## ${today} - PR #${pr.number}: ${pr.title}`;
+
+            let entry = `${header}\n\n`;
+            if (changeSummary) entry += `**Change Summary**\n${changeSummary}\n\n`;
+            if (howItWorks)   entry += `**How It Works**\n${howItWorks}\n\n`;
+            if (notes)        entry += `**Additional Notes**\n${notes}\n\n`;
+
+            core.setOutput('should_update', 'true');
+            core.setOutput('entry', entry);
+
+      - name: Append to LEARNINGS.md
+        if: steps.build.outputs.should_update == 'true'
         run: |
-          echo "" >> LEARNINGS.md
-          echo "## $(date +'%Y-%m-%d') — PR #${{ github.event.pull_request.number }} ${GITHUB_REPOSITORY}" >> LEARNINGS.md
-          echo "${{ steps.extract.outputs.learned }}" >> LEARNINGS.md
-          echo "" >> LEARNINGS.md
+          touch LEARNINGS.md
+          printf "\n%s" "${{ steps.build.outputs.entry }}" >> LEARNINGS.md
           git config user.name "github-actions[bot]"
           git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
           git add LEARNINGS.md