Skeleton

Author: ralfhandl

.github/workflows/schema-publish.yaml

@@ -0,0 +1,62 @@
+name: schema-publish
+
+# author: @ralfhandl
+# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715
+
+#
+# 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
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch: {}
+
+jobs:
+  publish:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4 # checkout main branch
+      with:
+        fetch-depth: 0
+
+    - uses: actions/setup-node@v4 # setup Node.js
+      with:
+        node-version: '20.x'
+    
+    - name: Install dependencies
+      run: npm ci
+
+    - uses: actions/checkout@v4 # 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: publish-schema-iteration
+        base: gh-pages
+        delete-branch: true
+        path: deploy
+        labels: Housekeeping,Schema
+        reviewers: OAI/tsc #TODO: check if this works, or if groups need a different parameter
+        # team-reviewers: OAI/tsc #TODO: check if this works, or if it needs a special access token
+        title: Publish OpenAPI Metaschema Iterations
+        commit-message: New OpenAPI metaschema 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.
+
+

scripts/schema-publish.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# Author: @ralfhandl
+
+# run this script from the root of the repo. It is designed to be run by a GitHub workflow.
+
+for filename in schemas/v3*/schema.yaml ; do
+  version=$(basename $(dirname "$filename"))
+  mkdir -p deploy/oas/$version
+
+  lastCommitDate=$(git log -1 --format="%ad" --date=format:"%Y%m%d" "$filename")
+
+  echo $filename $lastCommitDate $version
+  #TODO:
+  # - generate JSON file "deploy/oas/$version/schema/$lastCommitDate" from schema.yaml
+  # - if schema-base.yaml exists, generate JSON file "deploy/oas/$version/schema-base/$lastCommitDate" from schema-base.yaml
+done