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
|`yarn build-src`| full check: validation, HTML build, schema publish |
212
+
|`yarn test`| runs the JSON Schema and build tooling test suites |
212
213
213
-
5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes
214
+
5. After `yarn build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes
214
215
215
-
Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.
216
+
Please make sure the markdown validates and builds, and that `yarn test` passes, before creating a pull request or marking a draft pull request as ready for review.
216
217
217
218
## Reviewers
218
219
@@ -239,13 +240,13 @@ The steps for creating a `vX.Y.Z-rel` branch are:
239
240
2. Merge `main` into `dev` and `dev` into `vX.Y-dev` via PRs
240
241
- sync PRs are automatically created by workflows `sync-main-to-dev` and `sync-dev-to-vX.Y-dev`
241
242
3. Prepare spec files in `vX.Y-dev`
242
-
-`npm run format-markdown`
243
-
-`npm run build-src`
243
+
-`yarn format-markdown`
244
+
-`yarn build-src`
244
245
- open `deploy-preview/oas.html` in browser and verify correct formatting
245
246
- adjust and repeat until done
246
247
- merge changes to `src/oas.md` back into `vX.Y-dev` via PR
247
248
4. Create `vX.Y.Z-rel` from `vX.Y-dev` and adjust it
248
-
-`npm run adjust-release-branch` does this:
249
+
-`yarn adjust-release-branch` does this:
249
250
- 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
250
251
- copy file `EDITORS.md` to `versions/X.Y.Z-editors.md`
251
252
- delete folder `src`
@@ -266,7 +267,7 @@ unexpectedly, check this repository's `spec.config.json` first, then see the
266
267
267
268
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:
268
269
269
-
1. Run `npm run start-release` in branch `vX.Y-dev` to
270
+
1. Run `yarn start-release` in branch `vX.Y-dev` to
270
271
- create branch `vX.Y-dev-start-X.Y.(Z+1)`
271
272
- initialize `src/oas.md` with empty history and content from `versions/X.Y.Z.md`
272
273
- 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`
@@ -280,7 +281,7 @@ Alternatively, if no patch version X.Y.(Z+1) is planned, delete file `src/oas.md
280
281
A new minor version X.(Y+1).0 or major version (X+1).0.0 is started similarly:
281
282
282
283
1. Create branch `vX'.Y'-dev` from `vX.Y-dev`
283
-
2. Run `npm run start-release` in the new branch to
284
+
2. Run `yarn start-release` in the new branch to
284
285
- create branch `vX'.Y'-dev-start-X'.Y'.0`
285
286
- initialize `src/oas.md` with empty history and content from `versions/X.Y.Z.md`
286
287
- change version heading to X'.Y'.0 and add a new line to the version history table in Appendix A of `src/oas.md`
0 commit comments