spec-up-t 1.6.14 → 1.6.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.6.14",
+  "version": "1.6.16",
   "description": "Technical specification drafting tool that generates rich specification documents from markdown. Forked from https://github.com/decentralized-identity/spec-up by Daniel Buchner (https://github.com/csuwildcat)",
   "main": "./index",
   "repository": {

package/src/install-from-boilerplate/boilerplate/.github/workflows/menu.yml

@@ -131,8 +131,10 @@ jobs:
               git commit -m "Collect external references" || echo "No changes to commit"
               ;;
             freeze)
-              # snapshots/ is tracked in git — committing it triggers
-              # render-and-deploy.yml, which deploys the full spec with versions.
+              # snapshots/ is tracked in git and will be committed.
+              # Note: a GITHUB_TOKEN push does NOT automatically trigger other workflows
+              # (GitHub security restriction). render-and-deploy.yml is dispatched
+              # explicitly in the "Deploy frozen snapshots to GitHub Pages" step below.
               git commit -m "Freeze specification" || echo "No changes to commit"
               ;;
             custom-update)
@@ -146,6 +148,23 @@ jobs:
           # Push changes
           git push https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git HEAD:${{ github.ref_name }}
 
+      # After a freeze commit, render-and-deploy.yml must be dispatched explicitly.
+      # GitHub blocks other workflow runs triggered by GITHUB_TOKEN pushes (security
+      # restriction), so the push in "Commit and push changes" alone is not enough
+      # to propagate the new snapshot to the gh-pages branch.
+      # Dispatching render-and-deploy.yml here ensures:
+      #   1. The full render pipeline runs (including snapshots/ → docs/versions/ sync).
+      #   2. The updated docs/ (with the new frozen version) is deployed to gh-pages.
+      - name: Deploy frozen snapshots to GitHub Pages
+        if: success() && github.event.inputs.action_type == 'freeze'
+        run: |
+          curl -s -X POST \
+            -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+            -H "Accept: application/vnd.github+json" \
+            "https://api.github.com/repos/${{ github.repository }}/actions/workflows/render-and-deploy.yml/dispatches" \
+            -d "{\"ref\":\"${{ github.ref_name }}\"}"
+          echo "render-and-deploy.yml dispatched — frozen snapshots will be deployed to gh-pages"
+
       - name: Clean up
         if: always()
         run: |

package/src/install-from-boilerplate/migrate-versions-to-snapshots.js

@@ -18,6 +18,34 @@ const fs = require('fs-extra');
 const path = require('path');
 const Logger = require('../utils/logger');
 
+/**
+ * Extracts snapshot labels from a hand-edited docs/versions/index.html.
+ * Parses every anchor whose href points to a version directory (e.g. "v1/")
+ * and maps the directory name to the visible link text.
+ *
+ * Example input:  <a href="v1/">KERI Release 1.0</a>
+ * Example output: { "v1": "KERI Release 1.0" }
+ *
+ * The "Latest version" link (href="../") is intentionally ignored.
+ *
+ * @param {string} indexHtmlPath - Absolute path to docs/versions/index.html.
+ * @returns {Object} Map of version directory names to label strings.
+ */
+function extractLabelsFromIndexHtml(indexHtmlPath) {
+    const labels = {};
+    const html = fs.readFileSync(indexHtmlPath, 'utf8');
+    // Match: href="v1/" or href="v1" (with or without trailing slash)
+    const linkPattern = /href="(v\d+)\/?">([^<]+)<\/a>/g;
+    let match = linkPattern.exec(html);
+    while (match !== null) {
+        const dirName = match[1];
+        const linkText = match[2].trim();
+        labels[dirName] = linkText;
+        match = linkPattern.exec(html);
+    }
+    return labels;
+}
+
 /**
  * Migrates frozen snapshots from docs/versions/ to snapshots/.
  * @param {string} outputPath - The output directory defined in specs.json (e.g. './docs').
@@ -57,21 +85,29 @@ function migrateVersionsToSnapshots(outputPath) {
     });
 
     // Always keep labels.json up to date in snapshots/.
+    // Priority order (highest wins):
+    //   1. Labels already in snapshots/labels.json (from previous migrations or freezes)
+    //   2. Labels extracted from hand-edited docs/versions/index.html
+    //   3. Labels from docs/versions/labels.json (auto-generated source)
     const srcLabels = path.join(src, 'labels.json');
+    const srcIndexHtml = path.join(src, 'index.html');
     const destLabels = path.join(dest, 'labels.json');
 
-    if (fs.existsSync(srcLabels)) {
-        if (!fs.existsSync(destLabels)) {
-            // No labels.json in snapshots/ yet — copy the whole file.
-            fs.copySync(srcLabels, destLabels);
-        } else {
-            // Merge: preserve any entries already in snapshots/labels.json
-            // and add any entries from docs/versions/labels.json that are missing.
-            const existing = fs.readJsonSync(destLabels);
-            const legacy = fs.readJsonSync(srcLabels);
-            const merged = { ...legacy, ...existing }; // snapshots wins on conflict
-            fs.writeJsonSync(destLabels, merged, { spaces: 2 });
-        }
+    // Start from labels.json if it exists
+    const legacyLabels = fs.existsSync(srcLabels) ? fs.readJsonSync(srcLabels) : {};
+
+    // Overlay with labels parsed from index.html — these may be hand-edited
+    const htmlLabels = fs.existsSync(srcIndexHtml)
+        ? extractLabelsFromIndexHtml(srcIndexHtml)
+        : {};
+
+    // Existing snapshots/labels.json wins on any conflict
+    const existingDestLabels = fs.existsSync(destLabels) ? fs.readJsonSync(destLabels) : {};
+
+    const merged = { ...legacyLabels, ...htmlLabels, ...existingDestLabels };
+
+    if (Object.keys(merged).length > 0) {
+        fs.writeJsonSync(destLabels, merged, { spaces: 2 });
     }
 
     if (migratedCount > 0) {