Schema Publish workflow#4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ralfhandl merged 5 commits into from
Nov 7, 2024
Merged

Schema Publish workflow #4162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
44a759c
Publish script
ralfhandl Oct 25, 2024
6a4b0f4
Update schema-publish.yaml
ralfhandl Oct 25, 2024
fd5cdc2
Update schema-publish.yaml
ralfhandl Oct 25, 2024
d687024
Loop over hash keys
ralfhandl Oct 26, 2024
6d04eeb
More intuitive variable name, more comments
ralfhandl Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/schema-publish.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
name: schema-publish

# author: @ralfhandl
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715

#
# This workflow copies the 3.x schemas to the gh-pages branch
#

# 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
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.
0 schemas/v3.1/dialect/base.schema.yaml → schemas/v3.1/dialect.yaml
View file
Open in desktop
File renamed without changes.
0 schemas/v3.1/meta/base.schema.yaml → schemas/v3.1/meta.yaml
View file
Open in desktop
File renamed without changes.
54 changes: 54 additions & 0 deletions scripts/schema-publish.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# Run this script from the root of the repo. It is designed to be run by a GitHub workflow.

for schemaDir in schemas/v3* ; do
vVersion=$(basename "$schemaDir")
version=${vVersion:1}
echo $version

# list of schemas to process, dependent schemas come first
schemas=(meta.yaml dialect.yaml schema.yaml schema-base.yaml)

# find the newest commit date for each schema
maxDate=""
declare -A datesHash
for schema in "${schemas[@]}"; do
if [ -f "$schemaDir/$schema" ]; then
newestCommitDate=$(git log -1 --format="%ad" --date=short "$schemaDir/$schema")

# the newest date across a schema and all its dependencies is its date stamp
if [ "$newestCommitDate" \> "$maxDate" ]; then
maxDate=$newestCommitDate
fi
datesHash["$schema"]=$maxDate

@handrewshandrewsOct 26, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want each datesHash["$schema"] to have $schema's date, which would be $lastCommitDate and not $maxDate? It's not clear to me what $maxDate is intended to do here.

@ralfhandlralfhandlOct 28, 2024•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The schemas are visited in the order of their dependency:

  • If meta changes, dialect needs to be updated. If dialect itself has changed, its new date is the maximum of the two change dates.
  • If dialect changes, schema needs to be updated. If schema itself has changed, its new date is the maximum of the two change dates.
  • If schema changes, schema_base needs to be updated. If schema_base itself has changed, its new date is the maximum of the two change dates.

This is what the loop & $maxDate do because we currently have a linear dependency chain. If we get more files and non-linear dependencies, this has to be revisited.

echo $schema changed at $newestCommitDate
fi
done

# construct sed command
sedCmd=()
for schema in "${!datesHash[@]}"; do
base=$(basename "$schema" .yaml)
sedCmd+=("-e s/$base\/WORK-IN-PROGRESS/$base\/${datesHash[$schema]}/g")
done

# create the date-stamped schemas
for schema in "${!datesHash[@]}"; do
base=$(basename "$schema" .yaml)
target=deploy/oas/$version/$base/${datesHash[$schema]}

mkdir -p "deploy/oas/$version/$base"

sed ${sedCmd[@]} $schemaDir/$schema > $target.yaml
node scripts/yaml2json/yaml2json.js $target.yaml
rm $target.yaml
mv $target.json $target

mv deploy/oas/$version/$base/*.md $target.md
done

echo ""
done
2 changes: 1 addition & 1 deletion scripts/yaml2json/yaml2json.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ const fs = require('fs');
const yaml = require('yaml');

function convert(filename) {
console.log(filename);
// console.log(filename);
const s = fs.readFileSync(filename,'utf8');
let obj;
try {
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Schema Publish workflow#4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ralfhandl
merged 5 commits into

from

Nov 7, 2024
 Merged


Schema Publish workflow
#4162
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
44a759c

Publish script


ralfhandl Oct 25, 2024
6a4b0f4

Update schema-publish.yaml


ralfhandl Oct 25, 2024
fd5cdc2

Update schema-publish.yaml


ralfhandl Oct 25, 2024
d687024

Loop over hash keys


ralfhandl Oct 26, 2024
6d04eeb

More intuitive variable name, more comments


ralfhandl Oct 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


57 changes: 57 additions & 0 deletions
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
name: schema-publish

# author: @ralfhandl
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715

#
# This workflow copies the 3.x schemas to the gh-pages branch
#

# 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
 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.

0
schemas/v3.1/dialect/base.schema.yaml → schemas/v3.1/dialect.yaml

View file


Open in desktop


File renamed without changes.


0
schemas/v3.1/meta/base.schema.yaml → schemas/v3.1/meta.yaml

View file


Open in desktop


File renamed without changes.


54 changes: 54 additions & 0 deletions
scripts/schema-publish.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# Run this script from the root of the repo. It is designed to be run by a GitHub workflow.

for schemaDir in schemas/v3* ; do
 vVersion=$(basename "$schemaDir")
 version=${vVersion:1}
 echo $version

 # list of schemas to process, dependent schemas come first
 schemas=(meta.yaml dialect.yaml schema.yaml schema-base.yaml)

 # find the newest commit date for each schema
 maxDate=""
 declare -A datesHash
 for schema in "${schemas[@]}"; do
 if [ -f "$schemaDir/$schema" ]; then
 newestCommitDate=$(git log -1 --format="%ad" --date=short "$schemaDir/$schema")

 # the newest date across a schema and all its dependencies is its date stamp
 if [ "$newestCommitDate" \> "$maxDate" ]; then
 maxDate=$newestCommitDate
 fi
 datesHash["$schema"]=$maxDate
@handrewshandrewsOct 26, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want each datesHash["$schema"] to have $schema's date, which would be $lastCommitDate and not $maxDate? It's not clear to me what $maxDate is intended to do here.
@ralfhandlralfhandlOct 28, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The schemas are visited in the order of their dependency:
  • If meta changes, dialect needs to be updated. If dialect itself has changed, its new date is the maximum of the two change dates.
  • If dialect changes, schema needs to be updated. If schema itself has changed, its new date is the maximum of the two change dates.
  • If schema changes, schema_base needs to be updated. If schema_base itself has changed, its new date is the maximum of the two change dates.
This is what the loop & $maxDate do because we currently have a linear dependency chain. If we get more files and non-linear dependencies, this has to be revisited.
 echo $schema changed at $newestCommitDate
 fi
 done

 # construct sed command
 sedCmd=()
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 sedCmd+=("-e s/$base\/WORK-IN-PROGRESS/$base\/${datesHash[$schema]}/g")
 done

 # create the date-stamped schemas
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 target=deploy/oas/$version/$base/${datesHash[$schema]}

 mkdir -p "deploy/oas/$version/$base"

 sed ${sedCmd[@]} $schemaDir/$schema > $target.yaml
 node scripts/yaml2json/yaml2json.js $target.yaml
 rm $target.yaml
 mv $target.json $target

 mv deploy/oas/$version/$base/*.md $target.md
 done

 echo ""
done

2 changes: 1 addition & 1 deletion
scripts/yaml2json/yaml2json.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ const fs = require('fs');
const yaml = require('yaml');

function convert(filename) {
 console.log(filename);
// console.log(filename);
 const s = fs.readFileSync(filename,'utf8');
 let obj;
 try {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Schema Publish workflow#4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ralfhandl
merged 5 commits into

from

Nov 7, 2024
 Merged


Schema Publish workflow
#4162
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
44a759c

Publish script


ralfhandl Oct 25, 2024
6a4b0f4

Update schema-publish.yaml


ralfhandl Oct 25, 2024
fd5cdc2

Update schema-publish.yaml


ralfhandl Oct 25, 2024
d687024

Loop over hash keys


ralfhandl Oct 26, 2024
6d04eeb

More intuitive variable name, more comments


ralfhandl Oct 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


57 changes: 57 additions & 0 deletions
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
name: schema-publish

# author: @ralfhandl
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715

#
# This workflow copies the 3.x schemas to the gh-pages branch
#

# 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
 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.

0
schemas/v3.1/dialect/base.schema.yaml → schemas/v3.1/dialect.yaml

View file


Open in desktop


File renamed without changes.


0
schemas/v3.1/meta/base.schema.yaml → schemas/v3.1/meta.yaml

View file


Open in desktop


File renamed without changes.


54 changes: 54 additions & 0 deletions
scripts/schema-publish.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# Run this script from the root of the repo. It is designed to be run by a GitHub workflow.

for schemaDir in schemas/v3* ; do
 vVersion=$(basename "$schemaDir")
 version=${vVersion:1}
 echo $version

 # list of schemas to process, dependent schemas come first
 schemas=(meta.yaml dialect.yaml schema.yaml schema-base.yaml)

 # find the newest commit date for each schema
 maxDate=""
 declare -A datesHash
 for schema in "${schemas[@]}"; do
 if [ -f "$schemaDir/$schema" ]; then
 newestCommitDate=$(git log -1 --format="%ad" --date=short "$schemaDir/$schema")

 # the newest date across a schema and all its dependencies is its date stamp
 if [ "$newestCommitDate" \> "$maxDate" ]; then
 maxDate=$newestCommitDate
 fi
 datesHash["$schema"]=$maxDate
@handrewshandrewsOct 26, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want each datesHash["$schema"] to have $schema's date, which would be $lastCommitDate and not $maxDate? It's not clear to me what $maxDate is intended to do here.
@ralfhandlralfhandlOct 28, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The schemas are visited in the order of their dependency:
  • If meta changes, dialect needs to be updated. If dialect itself has changed, its new date is the maximum of the two change dates.
  • If dialect changes, schema needs to be updated. If schema itself has changed, its new date is the maximum of the two change dates.
  • If schema changes, schema_base needs to be updated. If schema_base itself has changed, its new date is the maximum of the two change dates.
This is what the loop & $maxDate do because we currently have a linear dependency chain. If we get more files and non-linear dependencies, this has to be revisited.
 echo $schema changed at $newestCommitDate
 fi
 done

 # construct sed command
 sedCmd=()
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 sedCmd+=("-e s/$base\/WORK-IN-PROGRESS/$base\/${datesHash[$schema]}/g")
 done

 # create the date-stamped schemas
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 target=deploy/oas/$version/$base/${datesHash[$schema]}

 mkdir -p "deploy/oas/$version/$base"

 sed ${sedCmd[@]} $schemaDir/$schema > $target.yaml
 node scripts/yaml2json/yaml2json.js $target.yaml
 rm $target.yaml
 mv $target.json $target

 mv deploy/oas/$version/$base/*.md $target.md
 done

 echo ""
done

2 changes: 1 addition & 1 deletion
scripts/yaml2json/yaml2json.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ const fs = require('fs');
const yaml = require('yaml');

function convert(filename) {
 console.log(filename);
// console.log(filename);
 const s = fs.readFileSync(filename,'utf8');
 let obj;
 try {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Schema Publish workflow#4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ralfhandl
merged 5 commits into

from

Nov 7, 2024
 Merged


Schema Publish workflow
#4162
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
44a759c

Publish script


ralfhandl Oct 25, 2024
6a4b0f4

Update schema-publish.yaml


ralfhandl Oct 25, 2024
fd5cdc2

Update schema-publish.yaml


ralfhandl Oct 25, 2024
d687024

Loop over hash keys


ralfhandl Oct 26, 2024
6d04eeb

More intuitive variable name, more comments


ralfhandl Oct 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


57 changes: 57 additions & 0 deletions
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
name: schema-publish

# author: @ralfhandl
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715

#
# This workflow copies the 3.x schemas to the gh-pages branch
#

# 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
 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.

0
schemas/v3.1/dialect/base.schema.yaml → schemas/v3.1/dialect.yaml

View file


Open in desktop


File renamed without changes.


0
schemas/v3.1/meta/base.schema.yaml → schemas/v3.1/meta.yaml

View file


Open in desktop


File renamed without changes.


54 changes: 54 additions & 0 deletions
scripts/schema-publish.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# Run this script from the root of the repo. It is designed to be run by a GitHub workflow.

for schemaDir in schemas/v3* ; do
 vVersion=$(basename "$schemaDir")
 version=${vVersion:1}
 echo $version

 # list of schemas to process, dependent schemas come first
 schemas=(meta.yaml dialect.yaml schema.yaml schema-base.yaml)

 # find the newest commit date for each schema
 maxDate=""
 declare -A datesHash
 for schema in "${schemas[@]}"; do
 if [ -f "$schemaDir/$schema" ]; then
 newestCommitDate=$(git log -1 --format="%ad" --date=short "$schemaDir/$schema")

 # the newest date across a schema and all its dependencies is its date stamp
 if [ "$newestCommitDate" \> "$maxDate" ]; then
 maxDate=$newestCommitDate
 fi
 datesHash["$schema"]=$maxDate
@handrewshandrewsOct 26, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want each datesHash["$schema"] to have $schema's date, which would be $lastCommitDate and not $maxDate? It's not clear to me what $maxDate is intended to do here.
@ralfhandlralfhandlOct 28, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The schemas are visited in the order of their dependency:
  • If meta changes, dialect needs to be updated. If dialect itself has changed, its new date is the maximum of the two change dates.
  • If dialect changes, schema needs to be updated. If schema itself has changed, its new date is the maximum of the two change dates.
  • If schema changes, schema_base needs to be updated. If schema_base itself has changed, its new date is the maximum of the two change dates.
This is what the loop & $maxDate do because we currently have a linear dependency chain. If we get more files and non-linear dependencies, this has to be revisited.
 echo $schema changed at $newestCommitDate
 fi
 done

 # construct sed command
 sedCmd=()
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 sedCmd+=("-e s/$base\/WORK-IN-PROGRESS/$base\/${datesHash[$schema]}/g")
 done

 # create the date-stamped schemas
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 target=deploy/oas/$version/$base/${datesHash[$schema]}

 mkdir -p "deploy/oas/$version/$base"

 sed ${sedCmd[@]} $schemaDir/$schema > $target.yaml
 node scripts/yaml2json/yaml2json.js $target.yaml
 rm $target.yaml
 mv $target.json $target

 mv deploy/oas/$version/$base/*.md $target.md
 done

 echo ""
done

2 changes: 1 addition & 1 deletion
scripts/yaml2json/yaml2json.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ const fs = require('fs');
const yaml = require('yaml');

function convert(filename) {
 console.log(filename);
// console.log(filename);
 const s = fs.readFileSync(filename,'utf8');
 let obj;
 try {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Schema Publish workflow#4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ralfhandl
merged 5 commits into

from

Nov 7, 2024
 Merged


Schema Publish workflow
#4162
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
44a759c

Publish script


ralfhandl Oct 25, 2024
6a4b0f4

Update schema-publish.yaml


ralfhandl Oct 25, 2024
fd5cdc2

Update schema-publish.yaml


ralfhandl Oct 25, 2024
d687024

Loop over hash keys


ralfhandl Oct 26, 2024
6d04eeb

More intuitive variable name, more comments


ralfhandl Oct 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


57 changes: 57 additions & 0 deletions
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
name: schema-publish

# author: @ralfhandl
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715

#
# This workflow copies the 3.x schemas to the gh-pages branch
#

# 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
 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.

0
schemas/v3.1/dialect/base.schema.yaml → schemas/v3.1/dialect.yaml

View file


Open in desktop


File renamed without changes.


0
schemas/v3.1/meta/base.schema.yaml → schemas/v3.1/meta.yaml

View file


Open in desktop


File renamed without changes.


54 changes: 54 additions & 0 deletions
scripts/schema-publish.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# Run this script from the root of the repo. It is designed to be run by a GitHub workflow.

for schemaDir in schemas/v3* ; do
 vVersion=$(basename "$schemaDir")
 version=${vVersion:1}
 echo $version

 # list of schemas to process, dependent schemas come first
 schemas=(meta.yaml dialect.yaml schema.yaml schema-base.yaml)

 # find the newest commit date for each schema
 maxDate=""
 declare -A datesHash
 for schema in "${schemas[@]}"; do
 if [ -f "$schemaDir/$schema" ]; then
 newestCommitDate=$(git log -1 --format="%ad" --date=short "$schemaDir/$schema")

 # the newest date across a schema and all its dependencies is its date stamp
 if [ "$newestCommitDate" \> "$maxDate" ]; then
 maxDate=$newestCommitDate
 fi
 datesHash["$schema"]=$maxDate
@handrewshandrewsOct 26, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want each datesHash["$schema"] to have $schema's date, which would be $lastCommitDate and not $maxDate? It's not clear to me what $maxDate is intended to do here.
@ralfhandlralfhandlOct 28, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The schemas are visited in the order of their dependency:
  • If meta changes, dialect needs to be updated. If dialect itself has changed, its new date is the maximum of the two change dates.
  • If dialect changes, schema needs to be updated. If schema itself has changed, its new date is the maximum of the two change dates.
  • If schema changes, schema_base needs to be updated. If schema_base itself has changed, its new date is the maximum of the two change dates.
This is what the loop & $maxDate do because we currently have a linear dependency chain. If we get more files and non-linear dependencies, this has to be revisited.
 echo $schema changed at $newestCommitDate
 fi
 done

 # construct sed command
 sedCmd=()
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 sedCmd+=("-e s/$base\/WORK-IN-PROGRESS/$base\/${datesHash[$schema]}/g")
 done

 # create the date-stamped schemas
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 target=deploy/oas/$version/$base/${datesHash[$schema]}

 mkdir -p "deploy/oas/$version/$base"

 sed ${sedCmd[@]} $schemaDir/$schema > $target.yaml
 node scripts/yaml2json/yaml2json.js $target.yaml
 rm $target.yaml
 mv $target.json $target

 mv deploy/oas/$version/$base/*.md $target.md
 done

 echo ""
done

2 changes: 1 addition & 1 deletion
scripts/yaml2json/yaml2json.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ const fs = require('fs');
const yaml = require('yaml');

function convert(filename) {
 console.log(filename);
// console.log(filename);
 const s = fs.readFileSync(filename,'utf8');
 let obj;
 try {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Schema Publish workflow#4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ralfhandl
merged 5 commits into

from

Nov 7, 2024
 Merged


Schema Publish workflow
#4162
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
44a759c

Publish script


ralfhandl Oct 25, 2024
6a4b0f4

Update schema-publish.yaml


ralfhandl Oct 25, 2024
fd5cdc2

Update schema-publish.yaml


ralfhandl Oct 25, 2024
d687024

Loop over hash keys


ralfhandl Oct 26, 2024
6d04eeb

More intuitive variable name, more comments


ralfhandl Oct 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


57 changes: 57 additions & 0 deletions
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
name: schema-publish

# author: @ralfhandl
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715

#
# This workflow copies the 3.x schemas to the gh-pages branch
#

# 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
 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.

0
schemas/v3.1/dialect/base.schema.yaml → schemas/v3.1/dialect.yaml

View file


Open in desktop


File renamed without changes.


0
schemas/v3.1/meta/base.schema.yaml → schemas/v3.1/meta.yaml

View file


Open in desktop


File renamed without changes.


54 changes: 54 additions & 0 deletions
scripts/schema-publish.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# Run this script from the root of the repo. It is designed to be run by a GitHub workflow.

for schemaDir in schemas/v3* ; do
 vVersion=$(basename "$schemaDir")
 version=${vVersion:1}
 echo $version

 # list of schemas to process, dependent schemas come first
 schemas=(meta.yaml dialect.yaml schema.yaml schema-base.yaml)

 # find the newest commit date for each schema
 maxDate=""
 declare -A datesHash
 for schema in "${schemas[@]}"; do
 if [ -f "$schemaDir/$schema" ]; then
 newestCommitDate=$(git log -1 --format="%ad" --date=short "$schemaDir/$schema")

 # the newest date across a schema and all its dependencies is its date stamp
 if [ "$newestCommitDate" \> "$maxDate" ]; then
 maxDate=$newestCommitDate
 fi
 datesHash["$schema"]=$maxDate
@handrewshandrewsOct 26, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want each datesHash["$schema"] to have $schema's date, which would be $lastCommitDate and not $maxDate? It's not clear to me what $maxDate is intended to do here.
@ralfhandlralfhandlOct 28, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The schemas are visited in the order of their dependency:
  • If meta changes, dialect needs to be updated. If dialect itself has changed, its new date is the maximum of the two change dates.
  • If dialect changes, schema needs to be updated. If schema itself has changed, its new date is the maximum of the two change dates.
  • If schema changes, schema_base needs to be updated. If schema_base itself has changed, its new date is the maximum of the two change dates.
This is what the loop & $maxDate do because we currently have a linear dependency chain. If we get more files and non-linear dependencies, this has to be revisited.
 echo $schema changed at $newestCommitDate
 fi
 done

 # construct sed command
 sedCmd=()
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 sedCmd+=("-e s/$base\/WORK-IN-PROGRESS/$base\/${datesHash[$schema]}/g")
 done

 # create the date-stamped schemas
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 target=deploy/oas/$version/$base/${datesHash[$schema]}

 mkdir -p "deploy/oas/$version/$base"

 sed ${sedCmd[@]} $schemaDir/$schema > $target.yaml
 node scripts/yaml2json/yaml2json.js $target.yaml
 rm $target.yaml
 mv $target.json $target

 mv deploy/oas/$version/$base/*.md $target.md
 done

 echo ""
done

2 changes: 1 addition & 1 deletion
scripts/yaml2json/yaml2json.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ const fs = require('fs');
const yaml = require('yaml');

function convert(filename) {
 console.log(filename);
// console.log(filename);
 const s = fs.readFileSync(filename,'utf8');
 let obj;
 try {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Schema Publish workflow#4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ralfhandl
merged 5 commits into

from

Nov 7, 2024
 Merged


Schema Publish workflow
#4162
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
44a759c

Publish script


ralfhandl Oct 25, 2024
6a4b0f4

Update schema-publish.yaml


ralfhandl Oct 25, 2024
fd5cdc2

Update schema-publish.yaml


ralfhandl Oct 25, 2024
d687024

Loop over hash keys


ralfhandl Oct 26, 2024
6d04eeb

More intuitive variable name, more comments


ralfhandl Oct 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


57 changes: 57 additions & 0 deletions
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
name: schema-publish

# author: @ralfhandl
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715

#
# This workflow copies the 3.x schemas to the gh-pages branch
#

# 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
 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.

0
schemas/v3.1/dialect/base.schema.yaml → schemas/v3.1/dialect.yaml

View file


Open in desktop


File renamed without changes.


0
schemas/v3.1/meta/base.schema.yaml → schemas/v3.1/meta.yaml

View file


Open in desktop


File renamed without changes.


54 changes: 54 additions & 0 deletions
scripts/schema-publish.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# Run this script from the root of the repo. It is designed to be run by a GitHub workflow.

for schemaDir in schemas/v3* ; do
 vVersion=$(basename "$schemaDir")
 version=${vVersion:1}
 echo $version

 # list of schemas to process, dependent schemas come first
 schemas=(meta.yaml dialect.yaml schema.yaml schema-base.yaml)

 # find the newest commit date for each schema
 maxDate=""
 declare -A datesHash
 for schema in "${schemas[@]}"; do
 if [ -f "$schemaDir/$schema" ]; then
 newestCommitDate=$(git log -1 --format="%ad" --date=short "$schemaDir/$schema")

 # the newest date across a schema and all its dependencies is its date stamp
 if [ "$newestCommitDate" \> "$maxDate" ]; then
 maxDate=$newestCommitDate
 fi
 datesHash["$schema"]=$maxDate
@handrewshandrewsOct 26, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want each datesHash["$schema"] to have $schema's date, which would be $lastCommitDate and not $maxDate? It's not clear to me what $maxDate is intended to do here.
@ralfhandlralfhandlOct 28, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The schemas are visited in the order of their dependency:
  • If meta changes, dialect needs to be updated. If dialect itself has changed, its new date is the maximum of the two change dates.
  • If dialect changes, schema needs to be updated. If schema itself has changed, its new date is the maximum of the two change dates.
  • If schema changes, schema_base needs to be updated. If schema_base itself has changed, its new date is the maximum of the two change dates.
This is what the loop & $maxDate do because we currently have a linear dependency chain. If we get more files and non-linear dependencies, this has to be revisited.
 echo $schema changed at $newestCommitDate
 fi
 done

 # construct sed command
 sedCmd=()
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 sedCmd+=("-e s/$base\/WORK-IN-PROGRESS/$base\/${datesHash[$schema]}/g")
 done

 # create the date-stamped schemas
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 target=deploy/oas/$version/$base/${datesHash[$schema]}

 mkdir -p "deploy/oas/$version/$base"

 sed ${sedCmd[@]} $schemaDir/$schema > $target.yaml
 node scripts/yaml2json/yaml2json.js $target.yaml
 rm $target.yaml
 mv $target.json $target

 mv deploy/oas/$version/$base/*.md $target.md
 done

 echo ""
done

2 changes: 1 addition & 1 deletion
scripts/yaml2json/yaml2json.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ const fs = require('fs');
const yaml = require('yaml');

function convert(filename) {
 console.log(filename);
// console.log(filename);
 const s = fs.readFileSync(filename,'utf8');
 let obj;
 try {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Schema Publish workflow#4162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

ralfhandl
merged 5 commits into

from

Nov 7, 2024
 Merged


Schema Publish workflow
#4162
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
44a759c

Publish script


ralfhandl Oct 25, 2024
6a4b0f4

Update schema-publish.yaml


ralfhandl Oct 25, 2024
fd5cdc2

Update schema-publish.yaml


ralfhandl Oct 25, 2024
d687024

Loop over hash keys


ralfhandl Oct 26, 2024
6d04eeb

More intuitive variable name, more comments


ralfhandl Oct 29, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


57 changes: 57 additions & 0 deletions
.github/workflows/schema-publish.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
name: schema-publish

# author: @ralfhandl
# issue: https://github.com/OAI/OpenAPI-Specification/issues/3715

#
# This workflow copies the 3.x schemas to the gh-pages branch
#

# 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
 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.

0
schemas/v3.1/dialect/base.schema.yaml → schemas/v3.1/dialect.yaml

View file


Open in desktop


File renamed without changes.


0
schemas/v3.1/meta/base.schema.yaml → schemas/v3.1/meta.yaml

View file


Open in desktop


File renamed without changes.


54 changes: 54 additions & 0 deletions
scripts/schema-publish.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env bash

# Author: @ralfhandl

# Run this script from the root of the repo. It is designed to be run by a GitHub workflow.

for schemaDir in schemas/v3* ; do
 vVersion=$(basename "$schemaDir")
 version=${vVersion:1}
 echo $version

 # list of schemas to process, dependent schemas come first
 schemas=(meta.yaml dialect.yaml schema.yaml schema-base.yaml)

 # find the newest commit date for each schema
 maxDate=""
 declare -A datesHash
 for schema in "${schemas[@]}"; do
 if [ -f "$schemaDir/$schema" ]; then
 newestCommitDate=$(git log -1 --format="%ad" --date=short "$schemaDir/$schema")

 # the newest date across a schema and all its dependencies is its date stamp
 if [ "$newestCommitDate" \> "$maxDate" ]; then
 maxDate=$newestCommitDate
 fi
 datesHash["$schema"]=$maxDate
@handrewshandrewsOct 26, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we want each datesHash["$schema"] to have $schema's date, which would be $lastCommitDate and not $maxDate? It's not clear to me what $maxDate is intended to do here.
@ralfhandlralfhandlOct 28, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The schemas are visited in the order of their dependency:
  • If meta changes, dialect needs to be updated. If dialect itself has changed, its new date is the maximum of the two change dates.
  • If dialect changes, schema needs to be updated. If schema itself has changed, its new date is the maximum of the two change dates.
  • If schema changes, schema_base needs to be updated. If schema_base itself has changed, its new date is the maximum of the two change dates.
This is what the loop & $maxDate do because we currently have a linear dependency chain. If we get more files and non-linear dependencies, this has to be revisited.
 echo $schema changed at $newestCommitDate
 fi
 done

 # construct sed command
 sedCmd=()
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 sedCmd+=("-e s/$base\/WORK-IN-PROGRESS/$base\/${datesHash[$schema]}/g")
 done

 # create the date-stamped schemas
 for schema in "${!datesHash[@]}"; do
 base=$(basename "$schema" .yaml)
 target=deploy/oas/$version/$base/${datesHash[$schema]}

 mkdir -p "deploy/oas/$version/$base"

 sed ${sedCmd[@]} $schemaDir/$schema > $target.yaml
 node scripts/yaml2json/yaml2json.js $target.yaml
 rm $target.yaml
 mv $target.json $target

 mv deploy/oas/$version/$base/*.md $target.md
 done

 echo ""
done

2 changes: 1 addition & 1 deletion
scripts/yaml2json/yaml2json.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ const fs = require('fs');
const yaml = require('yaml');

function convert(filename) {
 console.log(filename);
// console.log(filename);
 const s = fs.readFileSync(filename,'utf8');
 let obj;
 try {
Expand Down