You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -223,6 +223,34 @@ The steps for creating a `vX.Y.Z-rel` branch are:
223
223
224
224
The HTML renderings of the specification versions are generated from the `versions` directory on `main` by manually triggering 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).
225
225
226
+
#### Start Next Patch Version
227
+
228
+
Once the released specification version is [synced](#branch-sync-automation) back to the `vX.Y-dev` branch, the next patch version X.Y.(Z+1) can be started:
229
+
230
+
1. Run bash script `scripts/start-release.sh` in branch `vX.Y-dev` to
231
+
- create branch `vX.Y-dev-start-X.Y.(Z+1)`
232
+
- initialize `src/oas.md` with empty history and content from `versions/X.Y.Z.md`
233
+
- change version heading to X.Y.(Z+1) and add a new line to the version history table in Appendix A of `src/oas.md`
234
+
- commit and push changes
235
+
2. Merge `vX.Y-dev-start-X.Y.(Z+1)` into `vX.Y-dev` via pull request
236
+
237
+
Alternatively, if no patch version X.Y.(Z+1) is planned, delete file `src/oas.md` from branch `vX.Y-dev` via pull request.
238
+
239
+
#### Start New Minor or Major Version
240
+
241
+
A new minor version X.(Y+1).0 or major version (X+1).0.0 is started similarly:
242
+
243
+
1. Create branch `vX'.Y'-dev` from `vX.Y-dev`
244
+
2. Run bash script `scripts/start-release.sh` in the new branch to
245
+
- create branch `vX'.Y'-dev-start-X'.Y'.0`
246
+
- initialize `src/oas.md` with empty history and content from `versions/X.Y.Z.md`
247
+
- change version heading to X'.Y'.0 and add a new line to the version history table in Appendix A of `src/oas.md`
248
+
- change version in all schema files `src/schemas/validation/.yaml`
249
+
- change version in schema test script `tests/schema/schema.test.mjs`
250
+
- change version in schema test fixtures in folders `tests/schema/pass` and `tests/schema/fail`
251
+
- commit and push changes
252
+
3. Merge `vX'.Y'-dev-start-X'.Y'.0` into `vX'.Y'-dev` via pull request
253
+
226
254
### Schema Iterations
227
255
228
256
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).
0 commit comments