From b39614c0e3374150028906bb29bccf1183655af7 Mon Sep 17 00:00:00 2001 From: Jonathan Berkhahn Date: Mon, 10 Oct 2022 15:29:20 -0700 Subject: [PATCH] reformat release docs Signed-off-by: Jonathan Berkhahn --- .../docs/contribution-guidelines/releasing.md | 23 +++++++++++-------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/website/content/en/docs/contribution-guidelines/releasing.md b/website/content/en/docs/contribution-guidelines/releasing.md index a498482f3d6..c72c91159f8 100644 --- a/website/content/en/docs/contribution-guidelines/releasing.md +++ b/website/content/en/docs/contribution-guidelines/releasing.md @@ -71,16 +71,9 @@ We will use the `v1.3.0` release version in this example. git push -u upstream v1.3.x ``` 1. Make sure that the list of supported OLM versions stated in the [Overview][overview] section of SDK docs is updated. If a new version of OLM needs to be officially supported, follow the steps in [updating OLM bindata](#updating-olm-bindata) section. -1. Create and merge a commit that updates the top-level [Makefile] variable `IMAGE_VERSION` -to the upcoming release tag `v1.3.0`. This variable ensures sample projects have been tagged -correctly prior to the release commit. - ```sh - sed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile - ``` - For MAC users command will be little different. - ```sh - gsed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile - ``` + +### 0. Lock the `master` branch + 1. Lock down the `master` branch to prevent further commits before the release completes: 1. Go to `Settings -> Branches` in the SDK repo. 1. Under `Branch protection rules`, click `Edit` on the `master` branch rule. @@ -97,6 +90,16 @@ git pull git checkout -b release-$RELEASE_VERSION ``` +Update the top-level [Makefile] variable `IMAGE_VERSION` +to the upcoming release tag `v1.3.0`. This variable ensures sample projects have been tagged +correctly prior to the release commit. + ```sh + sed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile + ``` + For MAC users command will be little different. + ```sh + gsed -i -E 's/(IMAGE_VERSION = ).+/\1v1\.3\.0/g' Makefile + ``` Run the pre-release `make` target: ```sh