Merge branch 'main' into adjust-workflow-cron

baywet · web-flow · commit c02359a18a04 · 2025-10-21T09:46:32.000-04:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @oai/tsc
+* @oai/tsc @OAI/overlay-maintainers
diff --git a/.github/workflows/agenda.yaml b/.github/workflows/agenda.yaml
@@ -12,7 +12,7 @@ jobs:
       discussions: write
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Check if it's an alternate week
         id: check-week
         run: |
diff --git a/.github/workflows/respec.yaml b/.github/workflows/respec.yaml
@@ -4,68 +4,70 @@ name: respec
 # issue: https://github.com/OAI/OpenAPI-Specification/issues/1564
 
 #
-# This workflow updates the respec 'pretty' rendered versions of the spec 
+# This workflow updates the respec 'pretty' rendered versions of the spec
 # on the gh-pages branch when the corresponding markdown files change.
 #
 
-# run this on push to main
+# run this on push of new spec versions to main
 on:
   push:
+    paths:
+      - "versions/**"
     branches:
       - main
   workflow_dispatch: {}
 
 jobs:
   respec:
     if: github.repository == 'OAI/Overlay-Specification'
-    
+
     runs-on: ubuntu-22.04
 
     steps:
-    - 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: OpenAPI-Specification
-          
-    - uses: actions/checkout@v4 # checkout main branch
-      with:
-        fetch-depth: 0
+      - 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: OpenAPI-Specification
+
+      - uses: actions/checkout@v5 # checkout main branch
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v6 # setup Node.js
+        with:
+          node-version: "20.x"
 
-    - uses: actions/setup-node@v4 # setup Node.js
-      with:
-        node-version: '20.x'
-    
-    - name: Install dependencies
-      run: npm ci
+      - name: Install dependencies
+        run: npm ci
 
-    - uses: actions/checkout@v4 # checkout gh-pages branch
-      with:
-        token: ${{ steps.generate-token.outputs.token }}
-        repository: OAI/OpenAPI-Specification  # TODO: change to OAI/...
-        ref: gh-pages
-        path: deploy
+      - uses: actions/checkout@v5 # checkout gh-pages branch
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          repository: OAI/OpenAPI-Specification # TODO: change to OAI/...
+          ref: gh-pages
+          path: deploy
 
-    - name: run main script
-      run: scripts/md2html/build.sh
+      - 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: update-overlay-respec-version
-        base: gh-pages
-        delete-branch: true
-        path: deploy
-        labels: Housekeeping
-        reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,handrews,ralfhandl
-        title: Overlay - 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` in the OAI/Overlay-Specification repo.
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          branch: update-overlay-respec-version
+          base: gh-pages
+          delete-branch: true
+          path: deploy
+          labels: Housekeeping
+          reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,handrews,ralfhandl
+          title: Overlay - 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` in the OAI/Overlay-Specification repo.
 
-          The `versions/*.md` files have changed, so the HTML files are automatically being regenerated.
+            The `versions/*.md` files have changed, so the HTML files are automatically being regenerated.
diff --git a/.github/workflows/schema-publish.yaml b/.github/workflows/schema-publish.yaml
@@ -15,30 +15,31 @@ on:
 
 jobs:
   publish:
+    if: github.repository == 'OAI/Overlay-Specification'
     runs-on: ubuntu-latest
 
     steps:
       - name: Generate access token
         id: generate-token
-        uses: actions/create-github-app-token@v1
+        uses: actions/create-github-app-token@v2
         with:
           app-id: ${{ secrets.OAI_SPEC_PUBLISHER_APPID }}
           private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
           owner: OAI
           repositories: OpenAPI-Specification
           
-      - uses: actions/checkout@v4 # checkout main branch
+      - uses: actions/checkout@v5 # checkout main branch
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-node@v4 # setup Node.js
+      - uses: actions/setup-node@v6 # setup Node.js
         with:
           node-version: 20.x
 
       - name: Install dependencies
         run: npm ci
 
-      - uses: actions/checkout@v4 # checkout gh-pages branch
+      - uses: actions/checkout@v5 # checkout gh-pages branch
         with:
           token: ${{ steps.generate-token.outputs.token }}
           repository: OAI/OpenAPI-Specification
diff --git a/.github/workflows/schema-tests.yaml b/.github/workflows/schema-tests.yaml
@@ -8,30 +8,28 @@ name: schema-tests
 # testcases for the metaschemas
 #
 
-# run this on push to any branch and creation of pull-requests
-on: 
-  push: {}
+# run this on pull-requests (creation and updates) and on manual trigger
+on:
   pull_request: {}
   workflow_dispatch: {}
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4 # checkout repo content
-      with:
-        fetch-depth: 0
+      - uses: actions/checkout@v5 # checkout repo content
+        with:
+          fetch-depth: 0
 
-    - uses: actions/setup-node@v4 # setup Node.js
-      with:
-        node-version: '20.x'
+      - uses: actions/setup-node@v6 # setup Node.js
+        with:
+          node-version: "20.x"
 
-    - name: Install dependencies from main
-      run: |
-        # git checkout remotes/origin/main -- package.json package-lock.json #TODO: uncomment with subsequent PR
-        npm ci
+      - name: Install dependencies from main
+        run: |
+          # git checkout remotes/origin/main -- package.json package-lock.json #TODO: uncomment with subsequent PR
+          npm ci
 
-    - name: Run tests
-      run: npm test
+      - name: Run tests
+        run: npm test
diff --git a/.github/workflows/validate-markdown.yaml b/.github/workflows/validate-markdown.yaml
@@ -7,25 +7,26 @@ name: validate-markdown
 # This workflow validates markdown files in the versions directory matching *.md
 #
 
-# run this on push to any branch and creation of pull-requests
-on: [push, pull_request]
+# run this on pull-requests (creation and updates) and on manual trigger
+on:
+  pull_request: {}
+  workflow_dispatch: {}
 
 jobs:
   mdv:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4 # checkout repo content
-      with:
-        fetch-depth: 0
-    # - name: use the javascript environment from main
-    #   run: |
-    #     git checkout remotes/origin/main -- package.json package-lock.json .markdownlint.yaml
-    - uses: actions/setup-node@v4 # setup Node.js
-      with:
-        node-version: '20.x'
-    - name: Validate markdown
-      run: npx --yes mdv versions/*.md
-    - name: Lint markdown
-      run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/*.md
+      - uses: actions/checkout@v5 # checkout repo content
+        with:
+          fetch-depth: 0
+      # - name: use the javascript environment from main
+      #   run: |
+      #     git checkout remotes/origin/main -- package.json package-lock.json .markdownlint.yaml
+      - uses: actions/setup-node@v6 # setup Node.js
+        with:
+          node-version: "20.x"
+      - name: Validate markdown
+        run: npx --yes mdv versions/*.md
+      - name: Lint markdown
+        run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/*.md
diff --git a/README.md b/README.md
@@ -26,6 +26,7 @@ If you are looking for tools to use with Overlays, try these:
 - [oas-overlay-java](https://github.com/IBM/oas-overlay-java)
 - [Specmatic](https://specmatic.io/) - [Docs](https://docs.specmatic.io/documentation/contract_tests.html#overlays)
 - [BinkyLabs.OpenApi.Overlays - dotnet](https://github.com/BinkyLabs/openapi-overlays-dotnet)
+- [Legba - Clojure OpenAPI toolkit](https://github.com/mpenet/legba?tab=readme-ov-file#openapi-overlay-support)
 
 (Is something missing from the list? Send us a pull request to add it!)
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* @oai/tsc`
	`1`	`+* @oai/tsc @OAI/overlay-maintainers`