From 7a4a5d5aff89cc4a3b2222b4b2ca435fe6b2e67c Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Tue, 18 Mar 2025 11:00:59 +0100 Subject: [PATCH 1/3] Create adjust-release-branch.sh --- scripts/adjust-release-branch.sh | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 scripts/adjust-release-branch.sh diff --git a/scripts/adjust-release-branch.sh b/scripts/adjust-release-branch.sh new file mode 100644 index 0000000000..bbf0288602 --- /dev/null +++ b/scripts/adjust-release-branch.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +# Author: @ralfhandl + +# Run this script from the root of the repo. It is designed to be run manually in a release branch. + +branch=$(git branch --show-current) + +if [[ ! $branch =~ ^v[0-9]+\.[0-9]+\.[0-9]+-rel$ ]]; then + echo "This script is intended to be run from a release branch, e.g. v3.1.2-rel" + exit 1 +fi + +vVersion=$(basename "$branch" "-rel") +version=${vVersion:1} +echo Prepare release of $version + +cp EDITORS.md versions/$version-editors.md +mv src/oas.md versions/$version.md +rm -r src/schemas +rm -r tests/schema From 9ba315de2aa291c44d23e323085721f2f36fe60b Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Tue, 18 Mar 2025 11:15:08 +0100 Subject: [PATCH 2/3] Make executable --- scripts/adjust-release-branch.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 scripts/adjust-release-branch.sh diff --git a/scripts/adjust-release-branch.sh b/scripts/adjust-release-branch.sh old mode 100644 new mode 100755 From b1f703ff6526caa8ad9250ef02bc5d037e6d3c5e Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Wed, 19 Mar 2025 09:41:28 +0100 Subject: [PATCH 3/3] Mention in CONTRIBUTING.md --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fe1da2283..b21a477ab1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -199,7 +199,7 @@ The steps for creating a `vX.Y.Z-rel` branch are: 1. Update `EDITORS.md` on `main` 2. Merge `main` into `dev` and `dev` into `vX.Y-dev` via PRs - - Sync PRs are automatically created by workflows `sync-main-to-dev` and `sync-dev-to-vX.Y-dev` + - sync PRs are automatically created by workflows `sync-main-to-dev` and `sync-dev-to-vX.Y-dev` 3. Prepare spec files in `vX.Y-dev` - `npm run format-markdown` - `npm run build-src` @@ -211,6 +211,7 @@ The steps for creating a `vX.Y.Z-rel` branch are: - copy `EDITORS.md` to `versions/X.Y.Z-editors.md` - delete `src/schemas` - delete `tests/schema` + - bash script `scripts/adjust-release-branch.sh` performs these steps 5. Merge `vX.Y.Z-rel` into `main` via PR - this PR should only add files `versions/X.Y.Z.md` and `versions/X.Y.Z-editors.md`