Skip to content

Commit d368f35

Browse files
committed
Describe publishing process
Fixes #3715
1 parent 8e3015a commit d368f35

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

CONTRIBUTING.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -177,13 +177,19 @@ Reviews requesting changes should have their changes addressed regardless of how
177177

178178
## Publishing
179179

180-
The specification are published to the [spec site](https://spec.openapis.org) by creating an `vX.Y.Z-rel` branch where `src/oas.md` is renamed to the appropriate `versions/X.Y.Z.md` file and then merged to `main`.
181-
The HTML versions of the OAS are automatically generated from the `versions` directory on `main`.
180+
### Specification Versions
181+
182+
The specification versions are published to the [spec site](https://spec.openapis.org) by creating an `vX.Y.Z-rel` branch where `src/oas.md` is renamed to the appropriate `versions/X.Y.Z.md` file and then merged to `main`.
182183
This renaming on the `vX.Y.Z-rel` branch preserves the commit history for the published file on `main` when using `git log --follow` (as is the case for all older published files).
183184

184-
The schemas are published [in the schema section on the spec site](https://spec.openapis.org/#openapi-specification-schemas).
185-
As part of the publishing process, the `WORK-IN-PROGRESS` placeholders are replaced with dates as appropriate.
186-
Schemas are published/updated independently from the specification releases.
185+
The HTML renderings of the specification versions are automatically generated from the `versions` directory on `main` by the [`respec` workflow](https://github.com/OAI/OpenAPI-Specification/blob/main/.github/workflows/respec.yaml), which generates a pull request for publishing the HTML renderings to the [spec site](https://spec.openapis.org).
186+
187+
### Schema Iterations
188+
189+
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).
190+
Schemas are updated in and directly published from the `vX.Y-dev` branches.
191+
192+
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).
187193

188194
## Release Process and Scope
189195

0 commit comments

Comments
 (0)