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
Most contributors only need the commands shown below. Maintainers changing the
43
+
tooling itself should read the build-infra docs first.
44
+
28
45
29
46
### Active branches
30
47
@@ -228,7 +245,7 @@ The steps for creating a `vX.Y.Z-rel` branch are:
228
245
- adjust and repeat until done
229
246
- merge changes to `src/oas.md` back into `vX.Y-dev` via PR
230
247
4. Create `vX.Y.Z-rel` from `vX.Y-dev` and adjust it
231
-
-the bash script `scripts/adjust-release-branch.sh` does this:
248
+
-`npm run adjust-release-branch` does this:
232
249
- copy file `src/oas.md` to `versions/X.Y.Z.md` and replace the release date placeholder `| TBD |` in the history table of Appendix A with the current date
233
250
- copy file `EDITORS.md` to `versions/X.Y.Z-editors.md`
234
251
- delete folder `src`
@@ -240,11 +257,16 @@ The steps for creating a `vX.Y.Z-rel` branch are:
240
257
241
258
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).
242
259
260
+
The release commands are implemented in
261
+
[`OAI/build-infra`](https://github.com/OAI/build-infra). If a command behaves
262
+
unexpectedly, check this repository's `spec.config.json` first, then see the
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:
246
268
247
-
1. Run bash script `scripts/start-release.sh` in branch `vX.Y-dev` to
269
+
1. Run `npm run start-release` in branch `vX.Y-dev` to
248
270
- create branch `vX.Y-dev-start-X.Y.(Z+1)`
249
271
- initialize `src/oas.md` with empty history and content from `versions/X.Y.Z.md`
250
272
- 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`
@@ -258,7 +280,7 @@ Alternatively, if no patch version X.Y.(Z+1) is planned, delete file `src/oas.md
258
280
A new minor version X.(Y+1).0 or major version (X+1).0.0 is started similarly:
259
281
260
282
1. Create branch `vX'.Y'-dev` from `vX.Y-dev`
261
-
2. Run bash script `scripts/start-release.sh` in the new branch to
283
+
2. Run `npm run start-release` in the new branch to
262
284
- create branch `vX'.Y'-dev-start-X'.Y'.0`
263
285
- initialize `src/oas.md` with empty history and content from `versions/X.Y.Z.md`
264
286
- change version heading to X'.Y'.0 and add a new line to the version history table in Appendix A of `src/oas.md`
@@ -570,4 +592,3 @@ This process makes use of the following labels:
570
592
An issue is opened every week, 7 days in advance, for the Technical Developer Community (TDC), it provides the information to connect the meeting, and serves as a placeholder to build the agenda for the meeting. Anyone is welcome to attend the meeting, or to add items to the agenda as long as they plan on attending to present the item. These issues are also automatically pinned for visibility and labeled with "Housekeeping".
571
593
572
594
Ten (10) days after the meeting date is passed (date in the title of the issue), it gets closed and unpinned automatically.
Developing the next version of the OpenAPI Specification is guided by the [Technical Steering Committee (TSC)](MAINTAINERS.md). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to `main`.
37
44
38
45
The TSC holds weekly web conferences to review open pull requests and discuss open issues related to the evolving OpenAPI Specification. Participation in weekly calls and scheduled working sessions is open to the community. You can view the entire OpenAPI [technical meeting calendar](https://calendar.google.com/calendar/u/0/embed?src=c_fue82vsncog6ahhjvuokjo8qsk@group.calendar.google.com) online.
@@ -51,4 +58,3 @@ Not all feedback can be accommodated, and there may be solid arguments for or ag
0 commit comments