Skip to content

Commit f306a1a

Browse files
authored
Merge pull request #4881 from ralfhandl/main-update-CONTRIBUTING.md-publishing
main CONTRIBUTING.md: update Publishing section
2 parents feca45c + 5a0afa3 commit f306a1a

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -210,11 +210,13 @@ The steps for creating a `vX.Y.Z-rel` branch are:
210210
- adjust and repeat until done
211211
- merge changes to `src/oas.md` back into `vX.Y-dev` via PR
212212
4. Create `vX.Y.Z-rel` from `vX.Y-dev` and adjust it
213-
- move `src/oas.md` to `versions/X.Y.Z.md`
214-
- copy `EDITORS.md` to `versions/X.Y.Z-editors.md`
215-
- delete `src/schemas`
216-
- delete `tests/schema`
217-
- bash script `scripts/adjust-release-branch.sh` performs these steps
213+
- the bash script `scripts/adjust-release-branch.sh` does this:
214+
- move file `src/oas.md` to `versions/X.Y.Z.md`
215+
- copy file `EDITORS.md` to `versions/X.Y.Z-editors.md`
216+
- delete folder `src/schemas`
217+
- delete version-specific files and folders from `tests/schema`
218+
- file `schema.test.mjs`
219+
- folders `pass` and `fail`
218220
5. Merge `vX.Y.Z-rel` into `main` via PR
219221
- this PR should only add files `versions/X.Y.Z.md` and `versions/X.Y.Z-editors.md`
220222

@@ -343,7 +345,7 @@ For information on the branch and release strategy for OAS 3.0.4 and 3.1.1 and e
343345
* `dev` is the primary branch for working with the `src` tree. Development infrastructure that is not needed on `main` is maintained here, and can be merged out to other non-`main` branches as needed.
344346
Changes on `main` are automatically included in a pull request to `dev` (see the (section on [branch sync](#branch-sync-automation)).
345347
* `vX.Y-dev` is the minor release line development branch for X.Y, including both the initial X.Y.0 minor version and all subsequent X.Y.Z patch versions. All PRs are made to oldest active `vX.Y-dev` branch to which the change is relevant, and then merged forward as shown in the diagram further down in this document.
346-
* `vX.Y.Z-rel` is the release branch for an X.Y.Z release (including when Z == 0). It exists primarily for `git mv`-ing `src/oas.md` to the appropriate `versions/X.Y.Z.md` location before merging back to `main`, and can also be used for any emergency post-release fixes that come up, such as when a 3rd party changes URLs in a way that breaks published links.
348+
* `vX.Y.Z-rel` is the release branch for an X.Y.Z release (including when Z == 0). It exists primarily for `git mv`-ing `src/oas.md` to the appropriate `versions/X.Y.Z.md` location and removing schema-related files before merging back to `main`, and can also be used for any emergency post-release fixes that come up, such as when a 3rd party changes URLs in a way that breaks published links.
347349

348350
### Branching and merging (3.1.2, 3.2.0, and later)
349351

0 commit comments

Comments
 (0)