dev: sync with main

.github/dependabot.yml

@@ -1,12 +1,16 @@
 version: 2
 updates:
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    groups:
+      vitest:
+        patterns:
+          - "*vitest*"

.github/pull_request_template.md

@@ -8,8 +8,6 @@ present on the main branch, only on the development branches).
 * 3.1.x spec and schemas: v3.1-dev branch
 * 3.2.x spec and schemas: v3.2-dev branch
 * 3.3.x spec and schemas: v3.3-dev branch
-* registry templates: gh-pages branch, registry/...
-* registry contents: gh-pages branch, registries/...
 * process documentation and build infrastructure: main
 
 Note that we do not accept changes to published specifications.

.github/templates/agenda.md

@@ -32,5 +32,6 @@ Any other business (add comments below to suggest topics) | TDC | |
 [Approved spec PRs](https://github.com/OAI/OpenAPI-Specification/pulls?q=is%3Apr+is%3Aopen+review%3Aapproved) | @OAI/tsc | |
 [Active Projects](https://github.com/OAI/OpenAPI-Specification/projects?query=is%3Aopen) | @OAI/openapi-maintainers | |
 [New issues needing attention](https://github.com/search?q=repo%3Aoai%2Fopenapi-specification+is%3Aissue+comments%3A0+no%3Alabel+is%3Aopen) | @OAI/triage  | |
+Identify next week's meeting host (2 mins) | All | Comment on next week's agenda |
 
 /cc [@OAI/tsc](https://github.com/orgs/OAI/teams/tsc) please suggest items for inclusion.

.github/workflows/check-restricted-files.yaml

@@ -8,28 +8,32 @@ name: check-restricted-files
 on:
   pull_request:
     paths:
-      - 'schemas/**/*.yaml'
-      - 'versions/*.md'
+      - "versions/*.md"
 
 jobs:
   check-files:
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v5 # checkout repo content
+        with:
+          fetch-depth: 0
+
       - name: Check changed files
         shell: bash
         run: |
           if [[ "${{ github.event.pull_request.head.repo.full_name }}" == "OAI/OpenAPI-Specification" ]] && \
              [[ "${{ github.event.pull_request.base.repo.full_name }}" == "OAI/OpenAPI-Specification" ]]; then
- 
-            if [[ "${{ github.event.pull_request.head.ref }}" == "main" ]] && \
+
+            if [[ "${{ github.event.pull_request.head.ref }}" == "dev-sync-with-main" ]] && \
                [[ "${{ github.event.pull_request.base.ref }}" == "dev" ]]; then
-              echo Sync from main to dev
+              echo Sync from main to dev via ${{ github.event.pull_request.head.ref }}
               exit 0
             fi
 
-            if [[ "${{ github.event.pull_request.head.ref }}" == "dev" ]] && \
-               [[ "${{ github.event.pull_request.base.ref }}" =~ ^v[0-9]+\.[0-9]+-dev$ ]]; then
-              echo Sync from dev to ${{ github.event.pull_request.base.ref }}
+            if [[ "${{ github.event.pull_request.head.ref }}" =~ ^v[0-9]+\.[0-9]+-dev-sync-with-dev$ ]] && \
+               [[ "${{ github.event.pull_request.base.ref }}" =~ ^v[0-9]+\.[0-9]+-dev$ ]] && \
+               [[ ${{ github.event.pull_request.head.ref }} == ${{ github.event.pull_request.base.ref }}* ]]; then
+              echo Sync from dev to ${{ github.event.pull_request.base.ref }} via ${{ github.event.pull_request.head.ref }}
               exit 0
             fi
 
@@ -40,5 +44,8 @@ jobs:
             fi
           fi
 
-          echo This PR contains changes to files that should not be changed
+          echo This PR contains changes to files that should not be changed:
+          echo
+          git diff --compact-summary origin/${{ github.event.pull_request.base.ref }} origin/${{ github.event.pull_request.head.ref }} -- versions/
+
           exit 1

.github/workflows/respec.yaml

@@ -1,11 +1,10 @@
 name: respec
 
-# author: @MikeRalphson
+# author: @MikeRalphson, @ralfhandl
 # issue: https://github.com/OAI/OpenAPI-Specification/issues/1564
 
 #
-# This workflow updates the respec 'pretty' rendered versions of the spec 
-# on the gh-pages branch when the corresponding markdown files change.
+# This workflow creates a pull request for publishing HTML spec versions to the spec.openapis.org site.
 #
 
 # run this manually from main
@@ -19,41 +18,50 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v5 # checkout main branch
-      with:
-        fetch-depth: 0
-
-    - uses: actions/setup-node@v5 # setup Node.js
-      with:
-        node-version: '20.x'
-
-    - name: Install dependencies
-      run: npm ci
-
-    - uses: actions/checkout@v5 # checkout gh-pages branch
-      with:
-        ref: gh-pages
-        path: deploy
-
-    - name: run main script
-      run: scripts/md2html/build.sh
-
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v6
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        branch: update-respec-version
-        base: gh-pages
-        delete-branch: true
-        path: deploy
-        labels: Housekeeping
-        reviewers: earth2marsh,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge
-        title: Update ReSpec-rendered specification versions
-        commit-message: Update ReSpec-rendered specification versions
-        signoff: true
-        body: |
-          This pull request is automatically triggered by GitHub action `respec`.
-
-          The `versions/*.md` files have changed, so the HTML files are automatically being regenerated.
+      - name: Generate access token
+        id: generate-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.OAI_SPEC_PUBLISHER_APPID }}
+          private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
+          owner: OAI
+          repositories: spec.openapis.org
 
+      - uses: actions/checkout@v5 # checkout main branch of this repo
+        with:
+          fetch-depth: 0
 
+      - uses: actions/setup-node@v6 # setup Node.js
+        with:
+          node-version: "22.x"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - uses: actions/checkout@v5 # checkout main branch of website repo
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          repository: OAI/spec.openapis.org
+          ref: main
+          path: deploy
+
+      - name: run main script
+        run: scripts/md2html/build.sh
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          branch: openapi-spec-versions
+          base: main
+          delete-branch: true
+          path: deploy
+          labels: OpenAPI,Specification
+          reviewers: earth2marsh,lornajane,mikekistler,miqui,ralfhandl,whitlockjc,handrews,karenetheridge
+          title: OpenAPI - update ReSpec-rendered specification versions
+          commit-message: Update ReSpec-rendered specification versions
+          signoff: true
+          body: |
+            This pull request is automatically generated by GitHub action `respec` in the OAI/OpenAPI-Specification repo.
+
+            The `versions/*.md` files of the OpenAPI Specification have changed and the corresponding HTML files are regenerated.

.github/workflows/schema-publish.yaml

@@ -4,58 +4,66 @@ name: schema-publish
 # issue: https://github.com/OAI/OpenAPI-Specification/issues/3715
 
 #
-# This workflow creates a pull request for publishing schema iterations to the gh-pages branch
+# This workflow creates a pull request for publishing schema iterations to the spec.openapis.org site.
 #
 
 # run this on push to vX.Y-dev branches or manually
 on:
   push:
     branches:
-      - 'v[0-9].[0-9]-dev'
+      - "v[0-9].[0-9]-dev"
     paths:
-      - 'src/schemas/validation/*.yaml'
-      - 'scripts/schema-publish.sh'
-      - '.github/workflows/schema-publish.yaml'
+      - "src/schemas/validation/*.yaml"
   workflow_dispatch: {}
 
 jobs:
   publish:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v5 # checkout main branch
-      with:
-        fetch-depth: 0
-
-    - uses: actions/setup-node@v5 # setup Node.js
-      with:
-        node-version: '22.x'
-
-    - name: Install dependencies
-      run: npm ci
-
-    - uses: actions/checkout@v5 # checkout gh-pages branch
-      with:
-        ref: gh-pages
-        path: deploy
-
-    - name: run main script
-      run: scripts/schema-publish.sh
-
-    - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v6
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        branch: ${{ github.ref_name }}-publish-schema-iteration
-        base: gh-pages
-        delete-branch: true
-        path: deploy
-        labels: Housekeeping,Schema
-        reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge
-        title: '${{ github.ref_name }}: publish OpenAPI schema iterations'
-        commit-message: New OpenAPI schema iterations
-        signoff: true
-        body: |
-          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.
+      - name: Generate access token
+        id: generate-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.OAI_SPEC_PUBLISHER_APPID }}
+          private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
+          owner: OAI
+          repositories: spec.openapis.org
+
+      - uses: actions/checkout@v5 # checkout main branch of this repo
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v6 # setup Node.js
+        with:
+          node-version: "22.x"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - uses: actions/checkout@v5 # checkout main branch of website repo
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          repository: OAI/spec.openapis.org
+          ref: main
+          path: deploy
+
+      - name: run main script
+        run: scripts/schema-publish.sh
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          branch: openapi-${{ github.ref_name }}-schema-iterations
+          base: main
+          delete-branch: true
+          path: deploy
+          labels: OpenAPI,Schema
+          reviewers: earth2marsh,lornajane,mikekistler,miqui,ralfhandl,whitlockjc,handrews,karenetheridge
+          title: "OpenAPI - publish ${{ github.ref_name }} schema iterations"
+          commit-message: "New OpenAPI schema iterations published from ${{ github.ref_name }}"
+          signoff: true
+          body: |
+            This pull request is automatically generated by GitHub action `schema-publish` in the OAI/OpenAPI-Specification repo.
+            The `src/schemas/validation/*.yaml` files have changed and JSON files are automatically generated.

.github/workflows/schema-tests.yaml

@@ -23,7 +23,7 @@ jobs:
       with:
         fetch-depth: 0
 
-    - uses: actions/setup-node@v5 # setup Node.js
+    - uses: actions/setup-node@v6 # setup Node.js
       with:
         node-version: '20.x'
 

.github/workflows/sync-dev-to-vX.Y-dev.yaml

@@ -15,6 +15,7 @@ on:
 
 jobs:
   sync-branches:
+    if: github.repository == 'OAI/OpenAPI-Specification'
     runs-on: ubuntu-latest
     steps:
       - name: Generate access token
@@ -61,11 +62,11 @@ jobs:
               --title "$BASE: sync with $HEAD" \
               --body "Merge relevant changes from \`$HEAD\` into \`$BASE\`.")
             echo ""
-            echo "PR to sync $DEV_BRANCH: $PR"
+            echo "PR to sync $BASE with $HEAD: $PR"
             sleep 10 # allow status checks to be triggered
 
             gh pr checks $PR --watch --required || continue
-            # gh pr merge $PR --merge --admin
+            gh pr merge $PR --merge --admin
           done
         env:
           GH_TOKEN: ${{ steps.generate-token.outputs.token }}

.github/workflows/sync-main-to-dev.yaml

@@ -15,6 +15,7 @@ on:
 
 jobs:
   sync-branch:
+    if: github.repository == 'OAI/OpenAPI-Specification'
     runs-on: ubuntu-latest
     steps:
       - name: Generate access token

.github/workflows/validate-markdown.yaml

@@ -3,13 +3,12 @@ name: validate-markdown
 # Author: @MikeRalphson
 # Issue: https://github.com/OAI/OpenAPI-Specification/issues/2130
 
-#
 # This workflow validates markdown files in the project root.
 # It also validates the work-in-progress specification file src/oas.md with slightly different rules.
-#
 
-# run this on push to any branch and creation of pull-requests
-on: [push, pull_request]
+# run this on pull requests (which includes pushes to their head branch)
+on:
+  - pull_request
 
 jobs:
   lint:
@@ -18,7 +17,7 @@ jobs:
     steps:
       - uses: actions/checkout@v5 # checkout repo content
 
-      - uses: actions/setup-node@v5 # setup Node.js
+      - uses: actions/setup-node@v6 # setup Node.js
         with:
           node-version: "20.x"
 
@@ -33,4 +32,4 @@ jobs:
         with:
           reporter: github-check
           fail_level: any
-          filter_mode: nofilter
+          filter_mode: file

.linkspector.yml

@@ -2,7 +2,7 @@ files:
   - src/oas.md
   - CONTRIBUTING.md
   - EDITORS.md
-  # - GOVERNANCE.md
+  - GOVERNANCE.md
   - IMPLEMENTATIONS.md
   - MAINTAINERS.md
   - README.md