Describe spec and schema publishing process #4363
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ralfhandl
changed the title
lornajane
reviewed
Feb 20, 2025
CONTRIBUTING.md
Outdated
| The schema iterations are published independently from the specification releases [in the schema section on the spec site](https://spec.openapis.org/#openapi-specification-schemas). | ||
| Schemas are updated in and directly published from the `vX.Y-dev` branches. | ||
|
|
||
| As part of the publishing process, the YAML source files are converted to JSON, renamed to the relevant last-changed dates, and `WORK-IN-PROGRESS` placeholders are replaced with these dates as appropriate. This is done by the `schema-publish` workflow on each `vX.Y-dev` branch, which generates a pull request for publishing the new schema iterations to the [spec site](https://spec.openapis.org). |
There was a problem hiding this comment.
How do I run the schema-publish workflow when I want to publish a schema? Can I do it through github's web interface, or something else?
There was a problem hiding this comment.
Correct:
- Actions tab
- Select
schema-publishon the left side - Press "Run workflow" on the right side, select branch and then "Run workflow"
I didn't add this because it is Github standard, and the UI will probably change over time.
lornajane
reviewed
Feb 20, 2025
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3715
Tick one of the following options: