spec-up-t 1.1.18 → 1.1.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.1.18",
+  "version": "1.1.21",
   "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

@@ -7,32 +7,31 @@ on:
         description: 'Select the script to run'
         type: choice
         required: true
-        default: 'render'
+        default: 'Render specification'
         options:
-          - edit
-          - render
-          - dev
-          - collectExternalReferencesCache
-          - collectExternalReferencesNoCache
-          - topdf
-          - freeze
-          - references
-          - help
-          - menu
-          - addremovexrefsource
-          - configure
-          - custom-update
+          # - Edit specification
+          - Render specification
+          # - Develop specification
+          - Collect external references (cached)
+          - Collect external references (no cache)
+          - Convert to PDF
+          - Freeze specification
+          - List references
+          # - Show help
+          # - Add/remove xref source
+          # - Configure specification
+          - Custom update
 
 jobs:
   build-and-deploy-spec:
     runs-on: ubuntu-latest
     permissions:
-      contents: write
+      contents: write  # Needed for pushing changes
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v4
         with:
-          persist-credentials: false
+          persist-credentials: false  # We’ll use MY_PAT for push
 
       - name: Set up Node.js
         uses: actions/setup-node@v4
@@ -60,42 +59,47 @@ jobs:
         env:
           MY_PAT: ${{ secrets.MY_PAT }} # Make the secret available as an env var
         run: |
-          case ${{ github.event.inputs.script }} in
-            "edit")
+          case "${{ github.event.inputs.script }}" in
+            "Edit specification")
               node -e "require('spec-up-t')()"
               ;;
-            "render")
+            "Render specification")
               node --no-warnings -e "require('spec-up-t/index.js')({ nowatch: true })"
               ;;
-            "dev")
+            "Develop specification")
               node -e "require('spec-up-t')({ dev: true })"
               ;;
-            "collectExternalReferencesCache")
+            "Collect external references (cached)")
               node --no-warnings -e "require('spec-up-t/src/collect-external-references.js').collectExternalReferences({cache: true})"
               ;;
-            "collectExternalReferencesNoCache")
+            "Collect external references (no cache)")
               node --no-warnings -e "require('spec-up-t/src/collect-external-references.js').collectExternalReferences({cache: false, pat: process.env.MY_PAT})"
               ;;
-            "topdf")
+            "Convert to PDF")
               node -e "require('spec-up-t/src/create-pdf.js')"
               ;;
-            "freeze")
+            "Freeze specification")
               node -e "require('spec-up-t/src/freeze.js')"
               ;;
-            "references")
+            "List references")
               node -e "require('spec-up-t/src/references.js')"
               ;;
-            "help")
+            "Show help")
               cat ./node_modules/spec-up-t/src/install-from-boilerplate/help.txt || echo "Help file not found"
               ;;
-            "addremovexrefsource")
+            "Add/remove xref source")
               node --no-warnings -e "require('spec-up-t/src/add-remove-xref-source.js')"
               ;;
-            "configure")
+            "Configure specification")
               node --no-warnings -e "require('spec-up-t/src/configure.js')"
               ;;
-            "custom-update")
+            "Custom update")
               npm update && node -e "require('spec-up-t/src/install-from-boilerplate/custom-update.js')"
+              git config --global user.email "actions@github.com"
+              git config --global user.name "GitHub Actions"
+              git add .
+              git commit -m "Custom update: Copy files from spec-up-t" || echo "No changes to commit"
+              git push https://x-access-token:${{ secrets.MY_PAT }}@github.com/${{ github.repository }}.git HEAD:main
               ;;
             *)
               echo "Unknown script: ${{ github.event.inputs.script }}"
@@ -104,8 +108,8 @@ jobs:
           esac
 
       - name: Deploy to GitHub Pages
-        if: success() && github.event.inputs.script != 'help'
-        uses: peaceiris/actions-gh-pages@v3.7.3
+        if: success() && github.event.inputs.script != 'Show help'
+        uses: actions/upload-artifact@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ${{ env.OUTPUT_PATH }}

package/src/install-from-boilerplate/boilerplate/.github/workflows/set-gh-pages.yml

@@ -1,40 +1,27 @@
-name: Set GitHub Pages
+name: Set GitHub Pages and Homepage
 
 on:
   workflow_dispatch:
-    inputs:
-      username:
-        description: 'Your GitHub username (optional, defaults to repository owner)'
-        required: false
 
 jobs:
-  configure-pages:
+  configure-pages-and-homepage:
     runs-on: ubuntu-latest
     permissions:
       contents: read  # To check branches
       pages: write   # To configure Pages settings
     steps:
-      - name: Determine repository owner
-        id: get-owner
-        run: |
-          OWNER="${{ github.event.inputs.username }}"
-          if [ -z "$OWNER" ]; then
-            OWNER="${{ github.repository_owner }}"
-          fi
-          echo "OWNER=$OWNER" >> $GITHUB_ENV
-
       - name: Check if gh-pages branch exists
         id: check-branch
         run: |
           RESPONSE=$(curl -s -o /dev/null -w "%{http_code}" \
-            -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+            -H "Authorization: token ${{ secrets.MY_PAT }}" \
             -H "Accept: application/vnd.github+json" \
-            https://api.github.com/repos/${{ env.OWNER }}/${{ github.repository }}/branches/gh-pages)
+            https://api.github.com/repos/${{ github.repository }}/branches/gh-pages)
           if [ "$RESPONSE" -eq 200 ]; then
             echo "gh-pages branch exists"
             echo "BRANCH_EXISTS=true" >> $GITHUB_ENV
           elif [ "$RESPONSE" -eq 404 ]; then
-            echo "Error: gh-pages branch does not exist in ${{ env.OWNER }}/${{ github.repository }}"
+            echo "Error: gh-pages branch does not exist in ${{ github.repository }}"
             exit 1
           else
             echo "Unexpected response code: $RESPONSE"
@@ -43,11 +30,70 @@ jobs:
 
       - name: Set GitHub Pages to gh-pages
         if: env.BRANCH_EXISTS == 'true'
+        env:
+          PAT: ${{ secrets.MY_PAT }}
         run: |
-          curl -L \
+          RESPONSE=$(curl -s -L \
             -X POST \
-            -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+            -H "Authorization: token $PAT" \
+            -H "Accept: application/vnd.github+json" \
+            https://api.github.com/repos/${{ github.repository }}/pages \
+            -d '{"source":{"branch":"gh-pages","path":"/"}}' \
+            -w "%{http_code}" -o response.json)
+          if [ "$RESPONSE" -eq 201 ] || [ "$RESPONSE" -eq 200 ]; then
+            echo "GitHub Pages set to gh-pages branch for ${{ github.repository }}"
+          else
+            echo "Failed to set GitHub Pages: $RESPONSE"
+            cat response.json
+            exit 1
+          fi
+
+      - name: Set repository homepage to GitHub Pages URL
+        if: env.BRANCH_EXISTS == 'true'
+        env:
+          PAT: ${{ secrets.MY_PAT }}
+        run: |
+          # Construct the expected GitHub Pages URL
+          REPO_NAME=$(echo "${{ github.repository }}" | cut -d'/' -f2)
+          OWNER=$(echo "${{ github.repository }}" | cut -d'/' -f1)
+          PAGES_URL="https://${OWNER}.github.io/${REPO_NAME}"
+
+          # Set the homepage via API
+          RESPONSE=$(curl -s -L \
+            -X PATCH \
+            -H "Authorization: token $PAT" \
+            -H "Accept: application/vnd.github+json" \
+            https://api.github.com/repos/${{ github.repository }} \
+            -d "{\"homepage\":\"${PAGES_URL}\"}" \
+            -w "%{http_code}" -o response.json)
+
+          if [ "$RESPONSE" -eq 200 ]; then
+            echo "Repository homepage set to $PAGES_URL for ${{ github.repository }}"
+          else
+            echo "Failed to set homepage: $RESPONSE"
+            cat response.json
+            exit 1
+          fi
+
+      - name: Verify homepage matches GitHub Pages URL
+        if: env.BRANCH_EXISTS == 'true'
+        env:
+          PAT: ${{ secrets.MY_PAT }}
+        run: |
+          # Construct the expected GitHub Pages URL
+          REPO_NAME=$(echo "${{ github.repository }}" | cut -d'/' -f2)
+          OWNER=$(echo "${{ github.repository }}" | cut -d'/' -f1)
+          EXPECTED_URL="https://${OWNER}.github.io/${REPO_NAME}"
+
+          # Fetch the current homepage from the repo
+          CURRENT_HOMEPAGE=$(curl -s -L \
+            -H "Authorization: token $PAT" \
             -H "Accept: application/vnd.github+json" \
-            https://api.github.com/repos/${{ env.OWNER }}/${{ github.repository }}/pages \
-            -d '{"source":{"branch":"gh-pages","path":"/"}}'
-          echo "GitHub Pages set to gh-pages branch for ${{ env.OWNER }}/${{ github.repository }}"
+            https://api.github.com/repos/${{ github.repository }} | jq -r '.homepage')
+
+          if [ "$CURRENT_HOMEPAGE" = "$EXPECTED_URL" ]; then
+            echo "Verified: Homepage is set to GitHub Pages URL ($EXPECTED_URL)"
+          else
+            echo "Error: Homepage ($CURRENT_HOMEPAGE) does not match expected GitHub Pages URL ($EXPECTED_URL)"
+            exit 1
+          fi

package/src/install-from-boilerplate/boilerplate/README.md

@@ -1,3 +1,5 @@
 # Documentation
 
-Read more about Spec-Up-T in the [documentation](https://trustoverip.github.io/spec-up-t-website/).
+Read more about Spec-Up-T in the [documentation](https://trustoverip.github.io/spec-up-t-website/).
+
+Written: 2025-02-27T15:38