Create PRs in new site repo

ralfhandl · ralfhandl · commit 36a2b59a294a · 2025-10-21T14:52:06.000+02:00
diff --git a/.github/workflows/respec.yaml b/.github/workflows/respec.yaml
@@ -1,71 +1,70 @@
 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 on push to main
+# run this manually or on push to main
 on:
   push:
     branches:
       - main
   workflow_dispatch: {}
 
 jobs:
-  respec:
+  publish:
     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: spec.openapis.org
+
+      - uses: actions/checkout@v5 # checkout main branch of this repo
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v5 # setup Node.js
+        with:
+          node-version: "22.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 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: 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: overlay-spec-versions
+          base: main
+          delete-branch: true
+          path: deploy
+          labels: Overlay,Specification
+          reviewers: 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 generated 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 of the OpenAPI Specification have changed and the corresponding HTML files are regenerated.
diff --git a/.github/workflows/schema-publish.yaml b/.github/workflows/schema-publish.yaml
@@ -3,12 +3,14 @@ name: schema-publish
 # author: @ralfhandl
 
 #
-# This workflow copies the x.y schemas 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 main
+# run this on push of new spec versions to main
 on:
   push:
+    paths:
+      - "versions/**"
     branches:
       - main
   workflow_dispatch: {}
@@ -25,24 +27,24 @@ jobs:
           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
+          repositories: spec.openapis.org
+
+      - uses: actions/checkout@v5 # checkout main branch of this repo
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-node@v4 # setup Node.js
+      - uses: actions/setup-node@v5 # setup Node.js
         with:
-          node-version: 20.x
+          node-version: "22.x"
 
       - name: Install dependencies
         run: npm ci
 
-      - uses: actions/checkout@v4 # checkout gh-pages branch
+      - uses: actions/checkout@v5 # checkout main branch of website repo
         with:
           token: ${{ steps.generate-token.outputs.token }}
-          repository: OAI/OpenAPI-Specification
-          ref: gh-pages
+          repository: OAI/spec.openapis.org
+          ref: main
           path: deploy
 
       - name: run main script
@@ -52,15 +54,15 @@ jobs:
         uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ steps.generate-token.outputs.token }}
-          branch: publish-overlay-schema-iteration
-          base: gh-pages
+          branch: overlay-${{ github.ref_name }}-schema-iterations
+          base: main
           delete-branch: true
           path: deploy
-          labels: Housekeeping,Schema
-          reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,handrews,ralfhandl
-          title: Overlay - Publish Schema Iterations
-          commit-message: New Overlay schema iterations
+          labels: Overlay,Schema
+          reviewers: earth2marsh,lornajane,mikekistler,miqui,handrews,ralfhandl
+          title: "Overlay - publish schema iterations"
+          commit-message: "New Overlay schema iterations published from ${{ github.ref_name }}"
           signoff: true
           body: |
-            This pull request is automatically triggered by GitHub action `schema-publish` in the OAI/Overlay-Specification repo.
+            This pull request is automatically generated by GitHub action `schema-publish` in the OAI/Overlay-Specification repo.
             The `schemas/**/*.yaml` files have changed and JSON files are automatically generated.
