junk: test a 3.1 patch release

.github/workflows/schema-publish.yaml

@@ -4,14 +4,18 @@ name: schema-publish
 # issue: https://github.com/OAI/OpenAPI-Specification/issues/3715
 
 #
-# This workflow copies the 3.x schemas to the gh-pages branch
+# This workflow creates a pull request for publishing schema iterations to the gh-pages branch
 #
 
-# run this on push to main
+# run this on push to vX.Y-dev branches or manually
 on:
   push:
     branches:
-      - main
+      - 'v[0-9].[0-9]-dev'
+    paths:
+      - 'src/schemas/validation/*.yaml'
+      - 'scripts/schema-publish.sh'
+      - '.github/workflows/schema-publish.yaml'
   workflow_dispatch: {}
 
 jobs:
@@ -26,7 +30,7 @@ jobs:
 
     - uses: actions/setup-node@v4 # setup Node.js
       with:
-        node-version: '20.x'
+        node-version: '22.x'
 
     - name: Install dependencies
       run: npm ci
@@ -43,15 +47,15 @@ jobs:
       uses: peter-evans/create-pull-request@v6
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
-        branch: publish-schema-iteration
+        branch: ${{ github.ref_name }}-publish-schema-iteration
         base: gh-pages
         delete-branch: true
         path: deploy
         labels: Housekeeping,Schema
         reviewers: darrelmiller,webron,earth2marsh,webron,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge
-        title: Publish OpenAPI Schema Iterations
+        title: '${{ github.ref_name }}: publish OpenAPI schema iterations'
         commit-message: New OpenAPI schema iterations
         signoff: true
         body: |
-          This pull request is automatically triggered by GitHub action `schema-publish`.
-          The `schemas/**/*.yaml` files have changed and JSON files are automatically generated.
+          This pull request is automatically generated by GitHub action `schema-publish`.
+          The `src/schemas/validation/*.yaml` files have changed and JSON files are automatically generated.

.github/workflows/validate-markdown.yaml

@@ -28,7 +28,7 @@ jobs:
         node-version: '20.x'
 
     - name: Validate markdown
-      run: npx --yes mdv versions/3.*.md
+      run: npx --yes mdv versions/3.*.md src/oas.md
 
     - name: Lint markdown 3.0.4, 3.1.1, and later
-      run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/3.0.4.md versions/3.1.[^0].md versions/3.[2-9].*.md
+      run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/3.0.4.md versions/3.1.[^0].md versions/3.[2-9].*.md src/oas.md

CONTRIBUTING.md

@@ -163,6 +163,19 @@ This might apply to, for example, Markdown files, automation, and scripts.
 For all pull requests, if they should not be merged yet for any reason (they depend on something else, you would like feedback from a specific reviewer), mark them as draft and they will not be merged while in that state.
 Draft pull requests can still be reviewed while in draft state.
 
+### Preview specification HTML locally
+
+The markdown source files are converted to HTML before publishing.
+To do this locally, please
+
+1. Install [Node.js](https://nodejs.org/)
+2. Check out this repo, go to the repo root, and switch to a development branch
+3. Execute `npm install` (once, repeat after merging upstream changes)
+4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
+5. Open output file `deploy-preview/oas.html` with a browser and check your changes
+
+Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.
+
 ## Reviewers
 
 > [!NOTE]

package.json

@@ -14,7 +14,10 @@
   "license": "Apache-2.0",
   "scripts": {
     "build": "bash ./scripts/md2html/build.sh",
-    "test": "c8 --100 vitest --watch=false && bash scripts/schema-test-coverage.sh"
+    "build-src": "npm run validate-markdown && bash ./scripts/md2html/build.sh src && bash ./scripts/schema-publish.sh src",
+    "test": "c8 --100 vitest --watch=false && bash scripts/schema-test-coverage.sh",
+    "format-markdown": "bash ./scripts/format-markdown.sh ./src/oas.md",
+    "validate-markdown": "npx mdv src/oas.md && npx markdownlint-cli src/oas.md"
   },
   "readmeFilename": "README.md",
   "files": [