Merge pull request #5037 from OAI/v3.2-dev-sync-with-dev

Author: ralfhandl

.github/pull_request_template.md

@@ -7,6 +7,7 @@ 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

.github/workflows/respec.yaml

@@ -47,7 +47,7 @@ jobs:
         delete-branch: true
         path: deploy
         labels: Housekeeping
-        reviewers: darrelmiller,webron,earth2marsh,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge
+        reviewers: earth2marsh,lornajane,mikekistler,miqui,ralfhandl,handrews,karenetheridge
         title: Update ReSpec-rendered specification versions
         commit-message: Update ReSpec-rendered specification versions
         signoff: true

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

@@ -11,6 +11,7 @@ on:
   push:
     branches:
       - dev
+  workflow_dispatch: {}
 
 jobs:
   sync-branches:
@@ -22,36 +23,49 @@ jobs:
         with:
           app-id: ${{ secrets.OAI_SPEC_PUBLISHER_APPID }}
           private-key: ${{ secrets.OAI_SPEC_PUBLISHER_PRIVATE_KEY }}
-    
+
       - name: Checkout repository
         uses: actions/checkout@v5
         with:
           fetch-depth: 0
+          token: ${{ steps.generate-token.outputs.token }}
 
       - name: Create pull requests
         id: pull_requests
         shell: bash
         run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
           DEV_BRANCHES=$(git branch -r --list origin/v?.?-dev)
           for DEV_BRANCH in $DEV_BRANCHES; do
             BASE=${DEV_BRANCH:7}
-            EXISTS=$(gh pr list --base $BASE --head $HEAD \
+            SYNC="$BASE-sync-with-$HEAD"
+            
+            git checkout -b $SYNC origin/$SYNC || git checkout -b $SYNC origin/$BASE
+            git merge origin/$HEAD -m "Merge $HEAD into $SYNC"
+            git checkout origin/$BASE src/*
+            git checkout origin/$BASE tests/*
+            git commit -m "Restored src/* and tests/*" || echo ""
+            git push -u origin $SYNC
+
+            EXISTS=$(gh pr list --base $BASE --head $SYNC \
               --json number --jq '.[] | .number')
             if [ ! -z "$EXISTS" ]; then
-              echo "PR #$EXISTS already wants to merge $HEAD into $BASE"
+              echo "PR #$EXISTS already wants to merge $SYNC into $BASE"
               continue
             fi
 
-            PR=$(gh pr create --base $BASE --head $HEAD \
+            PR=$(gh pr create --base $BASE --head $SYNC \
               --label "Housekeeping" \
-              --title "$BASE: update from $HEAD" \
-              --body "Merge \`$HEAD\` into \`$BASE\`.")
+              --title "$BASE: sync with $HEAD" \
+              --body "Merge relevant changes from \`$HEAD\` into \`$BASE\`.")
             echo ""
             echo "PR to sync $DEV_BRANCH: $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

@@ -11,6 +11,7 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch: {}
 
 jobs:
   sync-branch:
@@ -25,22 +26,36 @@ jobs:
 
       - name: Checkout repository
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+          token: ${{ steps.generate-token.outputs.token }}
 
       - name: Create pull request
         id: pull_request
         shell: bash
         run: |
-          EXISTS=$(gh pr list --base $BASE --head $HEAD \
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          SYNC="$BASE-sync-with-$HEAD"
+
+          git checkout -b $SYNC origin/$SYNC || git checkout -b $SYNC origin/$BASE
+          git merge origin/$HEAD -m "Merge $HEAD into $SYNC"
+          git checkout origin/$BASE src/*
+          git checkout origin/$BASE tests/*
+          git commit -m "Restored src/* and tests/*" || echo ""
+          git push -u origin $SYNC
+
+          EXISTS=$(gh pr list --base $BASE --head $SYNC \
             --json number --jq '.[] | .number')
           if [ ! -z "$EXISTS" ]; then
-            echo "PR #$EXISTS already wants to merge $HEAD into $BASE"
+            echo "PR #$EXISTS already wants to merge $SYNC into $BASE"
             exit 0
           fi
 
-          gh pr create --base $BASE --head $HEAD \
+          gh pr create --base $BASE --head $SYNC \
             --label "Housekeeping" \
-            --title "$BASE: update from $HEAD" \
-            --body "Merge \`$HEAD\` into \`$BASE\`."
+            --title "$BASE: sync with $HEAD" \
+            --body "Merge relevant changes from \`$HEAD\` into \`$BASE\`."
         env:
           GH_TOKEN: ${{ steps.generate-token.outputs.token }}
           HEAD: main

.github/workflows/validate-markdown.yaml

@@ -13,21 +13,24 @@ on: [push, pull_request]
 
 jobs:
   lint:
-
     runs-on: ubuntu-latest
 
     steps:
-  
-    - uses: actions/checkout@v5 # checkout repo content
-      with:
-        fetch-depth: 0
+      - uses: actions/checkout@v5 # checkout repo content
+
+      - uses: actions/setup-node@v5 # setup Node.js
+        with:
+          node-version: "20.x"
 
-    - uses: actions/setup-node@v5 # setup Node.js
-      with:
-        node-version: '20.x'
+      - name: Lint work-in-progress spec
+        run: npx --yes markdownlint-cli2 --config spec.markdownlint.yaml src/oas.md
 
-    - name: Lint work-in-progress spec
-      run: npx --yes markdownlint-cli2 --config spec.markdownlint.yaml src/oas.md
+      - name: Lint other files
+        run: npx --yes markdownlint-cli2 *.md
 
-    - name: Lint other files
-      run: npx --yes markdownlint-cli2 *.md
+      - name: Check links in markdown files
+        uses: umbrelladocs/action-linkspector@v1
+        with:
+          reporter: github-check
+          fail_level: any
+          filter_mode: nofilter

.linkspector.yml

@@ -0,0 +1,15 @@
+files:
+  - src/oas.md
+  - CONTRIBUTING.md
+  - EDITORS.md
+  # - GOVERNANCE.md
+  - IMPLEMENTATIONS.md
+  - MAINTAINERS.md
+  - README.md
+  - SECURITY_CONSIDERATIONS.md
+  - SPECIAL_INTEREST_GROUPS.md
+  - style-guide.md
+  - TOB.md
+ignorePatterns:
+  - pattern: 'clientdomain.com'
+  - pattern: 'example.org'

CONTRIBUTING.md

@@ -10,7 +10,7 @@ Exceptions may be made when links to external URLs have been changed by a 3rd pa
 
 Published versions of the specification are in the `versions/` folder.
 The under-development versions of the specification are in the file `src/oas.md` on the appropriately-versioned branch.
-For example, work on the next release for 3.2 is on `v3.2-dev` in the file `src/oas.md`.
+For example, work on the next patch release for 3.2 is on `v3.2-dev` in the file `src/oas.md`, and work on the next minor release with additional features for 3.3 is on `v3.3-dev`.
 
 The [spec site](https://spec.openapis.org) is the source of truth for the OpenAPI specification as it contains all the citations and author credits (the markdown in this repository was previously the authoritative version until 2024).
 
@@ -24,7 +24,8 @@ The current active specification releases are:
 | Version | Branch | Notes |
 | ------- | ------ | ----- |
 | 3.1.2 | `v3.1-dev` | active patch release line |
-| 3.2.0 | `v3.2-dev` | minor release in development |
+| 3.2.0 | `v3.2-dev` | active patch release line |
+| 3.3.0 | `v3.3-dev` | minor release in development |
 | 4.0.0 | [OAI/sig-moonwalk](https://github.com/OAI/sig-moonwalk) | [discussions only](https://github.com/OAI/sig-moonwalk/discussions) |
 
 

README.md

@@ -33,7 +33,7 @@ Looking to see how you can create your own OpenAPI definition, present it, or ot
 The current process for developing the OpenAPI Specification is described in
 the [Contributing Guidelines](CONTRIBUTING.md).
 
-Developing the next version of the OpenAPI Specification is guided by the [Technical Steering Committee (TSC)](https://www.openapis.org/participate/how-to-contribute/governance#TDC). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to `main`.
+Developing the next version of the OpenAPI Specification is guided by the [Technical Steering Committee (TSC)](MAINTAINERS.md). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to `main`.
 
 The TSC holds weekly web conferences to review open pull requests and discuss open issues related to the evolving OpenAPI Specification. Participation in weekly calls and scheduled working sessions is open to the community. You can view the entire OpenAPI [technical meeting calendar](https://calendar.google.com/calendar/u/0/[email protected]) online.