Skip to content
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.

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

3.2: update from dev branch #4375

Open
wants to merge 109 commits into
base: v3.2-dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
109 commits
Select commit Hold shift + click to select a range
4604a32
Bump markdownlint-cli from 0.42.0 to 0.43.0
dependabot[bot] Nov 25, 2024
4a9c374
Merge pull request #4224 from OAI/dependabot/npm_and_yarn/markdownlin…
ralfhandl Nov 25, 2024
eed5f41
Bump vitest from 2.1.5 to 2.1.6
dependabot[bot] Nov 27, 2024
b16545e
Merge pull request #4227 from OAI/dependabot/npm_and_yarn/vitest-2.1.6
ralfhandl Nov 27, 2024
42520b0
Bump vitest from 2.1.6 to 2.1.8
dependabot[bot] Dec 3, 2024
0b24a52
Merge pull request #4236 from OAI/dependabot/npm_and_yarn/vitest-2.1.8
ralfhandl Dec 3, 2024
dae5523
Start refactoring contributor information: issues, discusssions, roles
lornajane Dec 5, 2024
9b395fe
Fill in more missing sections and try to keep the ordering sane
lornajane Dec 9, 2024
31af874
Remove the now-outdated DEVELOPMENT file, it is replaced by CONTRIBUTING
lornajane Dec 9, 2024
4a81dcb
Add the style guide as a separate file
lornajane Dec 9, 2024
28c5df3
Apply suggestions from code review
lornajane Dec 10, 2024
299291f
Add better information about where the spec actually is in the repo
lornajane Dec 10, 2024
775a13b
Bump c8 from 10.1.2 to 10.1.3
dependabot[bot] Dec 11, 2024
c9d669b
Merge pull request #4247 from OAI/dependabot/npm_and_yarn/c8-10.1.3
ralfhandl Dec 11, 2024
b9f244f
Apply suggestions from code review
lornajane Dec 11, 2024
77b6518
Update markdown files from pull request feedback
lornajane Dec 11, 2024
3326a4b
Merge pull request #4246 from lornajane/refactor-contributing-file
lornajane Dec 12, 2024
fd8a69f
Bump highlight.js from 11.10.0 to 11.11.0
dependabot[bot] Dec 16, 2024
3d83a95
Build HTML from src/oas.md
ralfhandl Dec 16, 2024
b81346f
Merge pull request #4253 from OAI/dependabot/npm_and_yarn/highlight.j…
ralfhandl Dec 16, 2024
f8d8fe3
Bump respec from 35.1.2 to 35.2.1
dependabot[bot] Dec 17, 2024
6fa56f3
Merge pull request #4256 from OAI/dependabot/npm_and_yarn/respec-35.2.1
ralfhandl Dec 17, 2024
784e92f
Fix directory name of where we keep the spec
lornajane Dec 17, 2024
ba75c29
Merge pull request #4261 from lornajane/fix-spec-folder-naming
ralfhandl Dec 17, 2024
b3949bd
Separate main css from build script
Bellangelo Dec 18, 2024
f583ff9
Add dark mode styling
Bellangelo Dec 19, 2024
15aee42
Enable dark mode functionality
Bellangelo Dec 19, 2024
c94652e
Update tests
Bellangelo Dec 19, 2024
2e1267b
Update tests
Bellangelo Dec 19, 2024
973999a
Preferred color is not always the selected one
Bellangelo Dec 19, 2024
a2394b1
Format code
Bellangelo Dec 19, 2024
2372f30
Update tests
Bellangelo Dec 19, 2024
2dc8bdf
Update tests
Bellangelo Dec 19, 2024
3c8a5f6
Update tests
Bellangelo Dec 19, 2024
e25d753
Add dark.css contents directly to the main.css
Bellangelo Dec 19, 2024
10c10bc
Materialize lists of editors per spec version
ralfhandl Dec 19, 2024
dbec407
Simplify symlink creation
ralfhandl Dec 19, 2024
a3425f2
builld into deploy-preview
ralfhandl Dec 19, 2024
d5f765e
Remove unnecessarily request
Bellangelo Dec 20, 2024
ffa5176
Update tests
Bellangelo Dec 20, 2024
7027e0f
dark.css is used by the dark mode toggle in fixup.js
Bellangelo Dec 21, 2024
984ee11
Merge pull request #4271 from OAI/main
ralfhandl Dec 21, 2024
866a199
Bump @hyperjump/json-schema from 1.9.9 to 1.10.0
dependabot[bot] Dec 23, 2024
0b187b6
Temp files in deploy-preview
ralfhandl Dec 23, 2024
b9c7b91
Tempfile in folder next to js folder
ralfhandl Dec 23, 2024
acdc31c
Bump highlight.js from 11.11.0 to 11.11.1
dependabot[bot] Dec 26, 2024
74cae4b
Bump yaml from 2.6.1 to 2.7.0
dependabot[bot] Dec 31, 2024
49e7202
Merge pull request #4276 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl Jan 2, 2025
ee2dcc4
Merge pull request #4280 from OAI/dependabot/npm_and_yarn/highlight.j…
ralfhandl Jan 2, 2025
c47b1db
Merge pull request #4283 from OAI/dependabot/npm_and_yarn/yaml-2.7.0
ralfhandl Jan 2, 2025
796ce1a
Merge pull request #4270 from ralfhandl/main-materialize-list-of-edit…
lornajane Jan 5, 2025
b4517c0
Bump respec from 35.2.1 to 35.2.2
dependabot[bot] Jan 6, 2025
126d46a
Merge remote-tracking branch 'upstream/dev' into dev-build-src
ralfhandl Jan 8, 2025
71e5119
Add checkboxes to the PR template to indicate if schema updates are n…
lornajane Jan 10, 2025
bba1da7
Merge pull request #4297 from lornajane/add-schema-update-checkboxes
ralfhandl Jan 10, 2025
8a2bb17
Preview and lint spec changes
ralfhandl Jan 15, 2025
902e505
Merge pull request #4291 from OAI/dependabot/npm_and_yarn/respec-35.2.2
ralfhandl Jan 15, 2025
e8a0d07
Merge pull request #4254 from ralfhandl/dev-build-src
handrews Jan 15, 2025
f420a3e
Bump vitest from 2.1.8 to 3.0.1
dependabot[bot] Jan 17, 2025
cde67e1
validate markdown in build-src
ralfhandl Jan 18, 2025
38b83d0
Merge pull request #4308 from OAI/dependabot/npm_and_yarn/vitest-3.0.1
ralfhandl Jan 18, 2025
8eddd20
Bump vitest from 3.0.1 to 3.0.3
dependabot[bot] Jan 22, 2025
6455cb1
Bump @hyperjump/json-schema from 1.10.0 to 1.10.1
dependabot[bot] Jan 22, 2025
bf9155d
Merge pull request #4311 from ralfhandl/dev-validate-markdown-in-buil…
ralfhandl Jan 22, 2025
0d83975
Merge pull request #4316 from OAI/dependabot/npm_and_yarn/vitest-3.0.3
ralfhandl Jan 22, 2025
c1c275d
Use branch-local package-lock.json
ralfhandl Jan 22, 2025
10e9a01
Merge pull request #4317 from OAI/dependabot/npm_and_yarn/hyperjump/j…
handrews Jan 22, 2025
245a4e2
Merge pull request #4318 from ralfhandl/workflows-use-branch-local-pa…
lornajane Jan 23, 2025
2619d58
Bump vitest from 3.0.3 to 3.0.4
dependabot[bot] Jan 24, 2025
4cc0e82
Merge pull request #4321 from OAI/dependabot/npm_and_yarn/vitest-3.0.4
ralfhandl Jan 24, 2025
5495770
Update schema-tests.yaml: correct step description
ralfhandl Jan 24, 2025
8cf00a4
Merge pull request #4322 from OAI/ralfhandl-patch-1
handrews Jan 24, 2025
55f2da6
Bump markdownlint-cli from 0.43.0 to 0.44.0
dependabot[bot] Jan 27, 2025
d237e68
Merge pull request #4323 from OAI/dependabot/npm_and_yarn/markdownlin…
ralfhandl Jan 27, 2025
f84077c
Bump vitest from 3.0.4 to 3.0.5
dependabot[bot] Feb 4, 2025
60e0d46
Merge pull request #4329 from OAI/dependabot/npm_and_yarn/vitest-3.0.5
ralfhandl Feb 4, 2025
ec2727f
Bump @hyperjump/json-schema from 1.10.1 to 1.11.0
dependabot[bot] Feb 6, 2025
9a07bd0
Merge pull request #4332 from OAI/dependabot/npm_and_yarn/hyperjump/j…
ralfhandl Feb 6, 2025
78320b6
New script format-markdown
ralfhandl Feb 6, 2025
031d633
Merge pull request #4268 from Bellangelo/main-dark-mode
ralfhandl Feb 6, 2025
9449ce8
Build single targets
duncanbeevers Feb 8, 2025
639c6ca
fixup! Build single targets
duncanbeevers Feb 9, 2025
06a89cd
Update scripts/md2html/build.sh
ralfhandl Feb 10, 2025
8e3015a
Merge pull request #4342 from duncanbeevers/build-src-changes
ralfhandl Feb 10, 2025
328d6a3
Merge remote-tracking branch 'upstream/main' into dev-update-from-main
ralfhandl Feb 10, 2025
0980f61
Merge pull request #4344 from ralfhandl/dev-update-from-main
ralfhandl Feb 13, 2025
cefa986
Remove obsolete schemas folder
ralfhandl Feb 13, 2025
70ae381
Adjust README.md
ralfhandl Feb 13, 2025
d6d0fe7
Update schema-publish.yaml
ralfhandl Feb 13, 2025
b54b525
No loop, just work on src/schemas/validation
ralfhandl Feb 13, 2025
9d4f648
Update schema-publish.yaml
ralfhandl Feb 13, 2025
c43615c
npm script for building schemas locally
ralfhandl Feb 14, 2025
183ac8b
Run only on changes to inputs and scripts
ralfhandl Feb 14, 2025
bd302e3
Update schema-publish.yaml
ralfhandl Feb 14, 2025
494222b
Use branch name
ralfhandl Feb 14, 2025
4600360
Merge pull request #4336 from ralfhandl/dev-format-src-oas.md
ralfhandl Feb 17, 2025
1919c0b
build-src uses build.sh, remove build-src.sh
ralfhandl Feb 18, 2025
aaa779b
Update src/schemas/validation/README.md
ralfhandl Feb 18, 2025
0a41814
Update schema-publish.sh
ralfhandl Feb 18, 2025
3e2604f
Merge branch 'dev-schemas-live-in-src' of https://github.com/ralfhand…
ralfhandl Feb 18, 2025
6f75109
Update package.json
ralfhandl Feb 18, 2025
35b2333
Merge pull request #4369 from ralfhandl/dev-one-spec-build-script
lornajane Feb 20, 2025
afa9511
Update schema-publish.yaml
ralfhandl Feb 20, 2025
90f9f2f
Update README.md
ralfhandl Feb 20, 2025
92e5fc9
Merge pull request #4361 from ralfhandl/dev-schemas-live-in-src
lornajane Feb 20, 2025
5dc0d94
Use correct pattern
ralfhandl Feb 21, 2025
4056207
Merge pull request #4378 from ralfhandl/dev-fix-schema-publish.yaml
lornajane Feb 22, 2025
20117c7
Update schema-publish.sh
duncanbeevers Feb 15, 2025
5c8ce0e
Merge pull request #4376 from duncanbeevers/dev-schemas-live-in-src
ralfhandl Feb 25, 2025
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
6 changes: 6 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
20 changes: 12 additions & 8 deletions .github/workflows/schema-publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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.
6 changes: 2 additions & 4 deletions .github/workflows/schema-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
7 changes: 4 additions & 3 deletions .github/workflows/validate-markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ target
atlassian-ide-plugin.xml
node_modules/
deploy/
deploy-preview/
coverage/
history
Gemfile.lock
473 changes: 294 additions & 179 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

115 changes: 0 additions & 115 deletions DEVELOPMENT.md

This file was deleted.

Loading