Skip to content

main: comment steps in adjust-release-branch.sh and describe them in CONTRIBUTING.md #5026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

main: comment steps in adjust-release-branch.sh and describe them in CONTRIBUTING.md #5026

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ The steps for creating a `vX.Y.Z-rel` branch are:
- merge changes to `src/oas.md` back into `vX.Y-dev` via PR
4. Create `vX.Y.Z-rel` from `vX.Y-dev` and adjust it
- the bash script `scripts/adjust-release-branch.sh` does this:
- move file `src/oas.md` to `versions/X.Y.Z.md`
- 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
- copy file `EDITORS.md` to `versions/X.Y.Z-editors.md`
- delete folder `src/schemas`
- delete folder `src`
- delete version-specific files and folders from `tests/schema`
- file `schema.test.mjs`
- folders `pass` and `fail`
Expand Down
4 changes: 4 additions & 0 deletions scripts/adjust-release-branch.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ vVersion=$(basename "$branch" "-rel")
version=${vVersion:1}
echo Prepare release of $version

# create snapshot of current editors
cp EDITORS.md versions/$version-editors.md
# Replace release date placeholder with current date - should only appear in the history table
sed "s/| TBD |/| $today |/g" src/oas.md > versions/$version.md
# show what changed in the spec - should only be the history table line for the current release
diff -w src/oas.md versions/$version.md
# remove files that only exist in development branches and not on main
rm -r src
rm -r tests/schema/pass tests/schema/fail
rm tests/schema/schema.test.mjs