spec-up-t 1.1.20 → 1.1.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "spec-up-t",
3
- "version": "1.1.20",
3
+ "version": "1.1.22",
4
4
  "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)",
5
5
  "main": "./index",
6
6
  "repository": {
@@ -7,32 +7,31 @@ on:
7
7
  description: 'Select the script to run'
8
8
  type: choice
9
9
  required: true
10
- default: 'render'
10
+ default: 'Render specification'
11
11
  options:
12
- - edit
13
- - render
14
- - dev
15
- - collectExternalReferencesCache
16
- - collectExternalReferencesNoCache
17
- - topdf
18
- - freeze
19
- - references
20
- - help
21
- - menu
22
- - addremovexrefsource
23
- - configure
24
- - custom-update
12
+ # - Edit specification
13
+ - Render specification
14
+ # - Develop specification
15
+ - Collect external references (cached)
16
+ - Collect external references (no cache)
17
+ - Convert to PDF
18
+ - Freeze specification
19
+ - List references
20
+ # - Show help
21
+ # - Add/remove xref source
22
+ # - Configure specification
23
+ - Custom update
25
24
 
26
25
  jobs:
27
26
  build-and-deploy-spec:
28
27
  runs-on: ubuntu-latest
29
28
  permissions:
30
- contents: write
29
+ contents: write # Needed for pushing changes and deploying to Pages
31
30
  steps:
32
31
  - name: Checkout 🛎️
33
32
  uses: actions/checkout@v4
34
33
  with:
35
- persist-credentials: false
34
+ persist-credentials: false # We’ll use MY_PAT for push
36
35
 
37
36
  - name: Set up Node.js
38
37
  uses: actions/setup-node@v4
@@ -60,42 +59,47 @@ jobs:
60
59
  env:
61
60
  MY_PAT: ${{ secrets.MY_PAT }} # Make the secret available as an env var
62
61
  run: |
63
- case ${{ github.event.inputs.script }} in
64
- "edit")
62
+ case "${{ github.event.inputs.script }}" in
63
+ "Edit specification")
65
64
  node -e "require('spec-up-t')()"
66
65
  ;;
67
- "render")
66
+ "Render specification")
68
67
  node --no-warnings -e "require('spec-up-t/index.js')({ nowatch: true })"
69
68
  ;;
70
- "dev")
69
+ "Develop specification")
71
70
  node -e "require('spec-up-t')({ dev: true })"
72
71
  ;;
73
- "collectExternalReferencesCache")
72
+ "Collect external references (cached)")
74
73
  node --no-warnings -e "require('spec-up-t/src/collect-external-references.js').collectExternalReferences({cache: true})"
75
74
  ;;
76
- "collectExternalReferencesNoCache")
75
+ "Collect external references (no cache)")
77
76
  node --no-warnings -e "require('spec-up-t/src/collect-external-references.js').collectExternalReferences({cache: false, pat: process.env.MY_PAT})"
78
77
  ;;
79
- "topdf")
78
+ "Convert to PDF")
80
79
  node -e "require('spec-up-t/src/create-pdf.js')"
81
80
  ;;
82
- "freeze")
81
+ "Freeze specification")
83
82
  node -e "require('spec-up-t/src/freeze.js')"
84
83
  ;;
85
- "references")
84
+ "List references")
86
85
  node -e "require('spec-up-t/src/references.js')"
87
86
  ;;
88
- "help")
87
+ "Show help")
89
88
  cat ./node_modules/spec-up-t/src/install-from-boilerplate/help.txt || echo "Help file not found"
90
89
  ;;
91
- "addremovexrefsource")
90
+ "Add/remove xref source")
92
91
  node --no-warnings -e "require('spec-up-t/src/add-remove-xref-source.js')"
93
92
  ;;
94
- "configure")
93
+ "Configure specification")
95
94
  node --no-warnings -e "require('spec-up-t/src/configure.js')"
96
95
  ;;
97
- "custom-update")
96
+ "Custom update")
98
97
  npm update && node -e "require('spec-up-t/src/install-from-boilerplate/custom-update.js')"
98
+ git config --global user.email "actions@github.com"
99
+ git config --global user.name "GitHub Actions"
100
+ git add .
101
+ git commit -m "Custom update: Copy files from spec-up-t" || echo "No changes to commit"
102
+ git push https://x-access-token:${{ secrets.MY_PAT }}@github.com/${{ github.repository }}.git HEAD:main
99
103
  ;;
100
104
  *)
101
105
  echo "Unknown script: ${{ github.event.inputs.script }}"
@@ -104,7 +108,7 @@ jobs:
104
108
  esac
105
109
 
106
110
  - name: Deploy to GitHub Pages
107
- if: success() && github.event.inputs.script != 'help'
111
+ if: success() && github.event.inputs.script != 'Show help' && github.event.inputs.script != 'Show menu'
108
112
  uses: peaceiris/actions-gh-pages@v3.7.3
109
113
  with:
110
114
  github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -113,7 +117,7 @@ jobs:
113
117
  force_orphan: true
114
118
 
115
119
  - name: Clean up
116
- if: always() # Run even if previous steps fail
120
+ if: always()
117
121
  run: |
118
122
  echo "Cleaning up..."
119
123
  rm -rf node_modules
@@ -1,3 +1,5 @@
1
1
  # Documentation
2
2
 
3
- Read more about Spec-Up-T in the [documentation](https://trustoverip.github.io/spec-up-t-website/).
3
+ Read more about Spec-Up-T in the [documentation](https://trustoverip.github.io/spec-up-t-website/).
4
+
5
+ Written: 2025-02-27T15:38