Merge pull request #4454 from ralfhandl/main-adjust-release-branch

main: helper script for preparing a release branch

Author: miqui

CONTRIBUTING.md

@@ -201,7 +201,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`
@@ -213,6 +213,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`
 

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