Skip to content

Commit 9890c0c

Browse files
committed
Merge remote-tracking branch 'upstream/main' into v3.1-dev-merge-dev
2 parents 30f9333 + b5ab378 commit 9890c0c

File tree

6 files changed

+265
-256
lines changed

6 files changed

+265
-256
lines changed

.github/templates/agenda.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Meetings take place over Zoom: [https://zoom.us/j/975841675](https://zoom.us/j/9
2020

2121
| Blur My Background | Raise Hand |
2222
|-|-|
23-
| <img width="323" alt="Screenshot of Zoom UI showing the 'Stop Video' and 'Blur My Background' control" src="https://github.com/OAI/OpenAPI-Specification/assets/7367/7e43dbbb-6529-46e6-8b04-4c1aa852d9dd"> | <img width="323" alt="Screenshot of Zoom UI showing the 'Reaction' and 'Raise Hand' control" src="https://github.com/OAI/OpenAPI-Specification/assets/7367/f991722f-4651-40aa-9bc4-7e9a2a165a6a"> |
23+
| <img width="323" alt="Screenshot of Zoom UI showing the 'Stop Video' and 'Blur My Background' control" src="https://github.com/OAI/OpenAPI-Specification/assets/7367/7e43dbbb-6529-46e6-8b04-4c1aa852d9dd"> | <img width="323" alt="Screenshot of Zoom UI showing the 'Reaction' and 'Raise Hand' control" src="https://github.com/user-attachments/assets/bf19ee70-59b1-410e-b893-645f26c2c96e"> |
2424

2525
### Agenda Structure
2626

CONTRIBUTING.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,13 +190,19 @@ Reviews requesting changes should have their changes addressed regardless of how
190190

191191
## Publishing
192192

193-
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`.
194-
The HTML versions of the OAS are automatically generated from the `versions` directory on `main`.
193+
### Specification Versions
194+
195+
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`.
195196
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).
196197

197-
The schemas are published [in the schema section on the spec site](https://spec.openapis.org/#openapi-specification-schemas).
198-
As part of the publishing process, the `WORK-IN-PROGRESS` placeholders are replaced with dates as appropriate.
199-
Schemas are published/updated independently from the specification releases.
198+
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).
199+
200+
### Schema Iterations
201+
202+
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).
203+
Schemas are updated in and directly published from the `vX.Y-dev` branches.
204+
205+
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 usually done by the `schema-publish` workflow which detects changes 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). The workflow can also be run manually if required.
200206

201207
## Release Process and Scope
202208

0 commit comments

Comments
 (0)