Merge pull request #4397 from OAI/dev

v3.2-dev: update from dev

Author: ralfhandl

.github/pull_request_template.md

@@ -13,3 +13,9 @@ present on the main branch, only on the development branches).
 
 Note that we do not accept changes to published specifications.
 -->
+
+Tick one of the following options:
+
+- [ ] schema changes are included in this pull request
+- [ ] schema changes are needed for this pull request but not done yet
+- [ ] no schema changes are needed for this pull request

.github/templates/agenda.md

@@ -20,7 +20,7 @@ Meetings take place over Zoom: [https://zoom.us/j/975841675](https://zoom.us/j/9
 
 | Blur My Background | Raise Hand |
 |-|-|
-| <img width="323" alt="Screenshot of Zoom UI showing the 'Stop Video' and 'Blur My Background' control" src="https://github.com/OAI/OpenAPI-Specification/assets/7367/7e43dbbb-6529-46e6-8b04-4c1aa852d9dd"> | <img width="323" alt="Screenshot of Zoom UI showing the 'Reaction' and 'Raise Hand' control" src="https://github.com/OAI/OpenAPI-Specification/assets/7367/f991722f-4651-40aa-9bc4-7e9a2a165a6a"> |
+| <img width="323" alt="Screenshot of Zoom UI showing the 'Stop Video' and 'Blur My Background' control" src="https://github.com/OAI/OpenAPI-Specification/assets/7367/7e43dbbb-6529-46e6-8b04-4c1aa852d9dd"> | <img width="323" alt="Screenshot of Zoom UI showing the 'Reaction' and 'Raise Hand' control" src="https://github.com/user-attachments/assets/bf19ee70-59b1-410e-b893-645f26c2c96e"> |
 
 ### Agenda Structure
 

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

@@ -0,0 +1,22 @@
+name: check-restricted-files
+
+# Author: @ralfhandl
+# Issue: https://github.com/OAI/OpenAPI-Specification/issues/3432
+
+# This workflow fails if restricted files are changed in a pull request
+
+on:
+  pull_request:
+    paths:
+      - 'schemas/**/*.yaml'
+      - 'versions/*.md'
+
+jobs:
+  check-files:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check changed files
+        shell: bash
+        run: |
+          echo This PR contains changes to files that should not be changed
+          exit 1

.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/schema-tests.yaml

@@ -28,10 +28,8 @@ jobs:
       with:
         node-version: '20.x'
 
-    - name: Install dependencies from main
-      run: |
-        git checkout remotes/origin/main -- package.json package-lock.json
-        npm ci
+    - name: Install dependencies
+      run: npm ci
 
     - name: Run tests
       run: npm run test

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

@@ -0,0 +1,40 @@
+name: sync-main-to-dev
+
+# author: @ralfhandl
+
+#
+# This workflow creates PRs to update the dev branch with the latest changes from main
+#
+
+# run this on push to main
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  sync-branch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Create pull request
+        id: pull_request
+        shell: bash
+        run: |
+          EXISTS=$(gh pr list --base $BASE --head $HEAD \
+            --json number --jq '.[] | .number')
+          if [ ! -z "$EXISTS" ]; then
+            echo "PR #$EXISTS already wants to merge $HEAD into $BASE"
+            exit 0
+          fi
+
+          gh pr create --base $BASE --head $HEAD \
+            --label "Housekeeping" \
+            --title "$BASE: update from $HEAD" \
+            --body "Merge \`$HEAD\` into \`$BASE\`."
+        env:
+          GH_TOKEN: ${{ github.token }}
+          HEAD: main
+          BASE: dev

.github/workflows/validate-markdown.yaml

@@ -18,16 +18,17 @@ jobs:
     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/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 src/oas.md

.gitignore

@@ -6,6 +6,7 @@ target
 atlassian-ide-plugin.xml
 node_modules/
 deploy/
+deploy-preview/
 coverage/
 history
 Gemfile.lock