script and doc updates

Author: estroz

website/content/en/docs/contribution-guidelines/releasing.md

@@ -50,7 +50,7 @@ git checkout -b v1.3.x
 git push -u upstream v1.3.x
 ```
 
-### 2. Create and push a release commit
+### 1. Create and push a release commit
 
 Create a new branch to push the release commit:
 
@@ -81,23 +81,23 @@ git commit -m "Release v1.3.0"
 git push -u origin release-v1.3.0
 ```
 
-### 3. Create and merge a new PR
+### 2. Create and merge a new PR
 
 Create and merge a new PR for the above commit.
 
-### 4. Lock down branch `master`
+### 3. Lock down branch `master`
 
 Lock down the `master` branch to prevent further commits before the release completes.
 See [this section](#locking-down-branches) for steps to do so.
 
-### 5. Create and push a release tag
+### 4. Create and push a release tag
 
 ```sh
 make tag RELEASE_VERSION=v1.3.0
 git push upstream v1.3.0
 ```
 
-### 6. Fast-forward the `latest` and release branches
+### 5. Fast-forward the `latest` and release branches
 
 The `latest` branch points to the latest release tag to keep the main website subdomain up-to-date.
 Run the following commands to do so:
@@ -116,29 +116,27 @@ git reset --hard tags/v1.3.0
 git push -f upstream v1.3.x
 ```
 
-### 7. Unlock the `master` branch
+### 6. Unlock the `master` branch
 
 See [this guide](#unlocking-branches) for steps to do so.
 
+### 7. Post release steps
+
+See the [post-release section](#post-release-steps).
+
 
 ## Patch releases
 
 We will use the `v1.3.1` release version in this example.
 
-### 1. Check out the release branch
+### 1. Create and push a release commit
 
-The release branch should already exist for the desired minor version:
+Create a new branch from the release branch, which should already exist for the desired minor version,
+to push the release commit to:
 
 ```sh
 git checkout v1.3.x
 git pull
-```
-
-### 2. Create and push a release commit
-
-Create a new branch to push the release commit:
-
-```sh
 git checkout -b release-v1.3.1
 ```
 
@@ -161,23 +159,23 @@ git commit -m "Release v1.3.1"
 git push -u origin release-v1.3.1
 ```
 
-### 3. Create and merge a new PR
+### 2. Create and merge a new PR
 
 Create and merge a new PR for the above commit.
 
-### 4. Lock down the `v1.3.x` branch
+### 3. Lock down the `v1.3.x` branch
 
 Lock down this branch prevents further commits before the release completes.
 See [this section](#locking-down-branches) for steps to do so.
 
-### 5. Create and push a release tag
+### 4. Create and push a release tag
 
 ```sh
 make tag RELEASE_VERSION=v1.3.1
 git push upstream v1.3.1
 ```
 
-### 6. Fast-forward the `latest` branch
+### 5. Fast-forward the `latest` branch
 
 The `latest` branch points to the latest release tag to keep the main website subdomain up-to-date.
 Run the following commands to do so:
@@ -188,10 +186,13 @@ git reset --hard tags/v1.3.1
 git push -f upstream latest
 ```
 
-### 7. Unlock the `v1.3.x` branch
+### 6. Unlock the `v1.3.x` branch
 
 See [this guide](#unlocking-branches) for steps to do so.
 
+### 7. Post release steps
+
+See the [post-release section](#post-release-steps).
 
 ## Further reading
 
@@ -236,22 +237,20 @@ Make sure everyone in the relevant Slack channel is aware of the release so they
 
 ##### Unlocking branches
 
-<<<<<<< HEAD
-### 11. Announce the release
+Unlock a branch by changing the number of required approving reviewers back to 1.
+
+### Post-release steps
 
-Send an email to the [mailing list][mailing-list]
+##### Announce the release
+
+Send an email to the [mailing list][mailing-list].
 Post to Kubernetes slack in #kubernetes-operators and #operator-sdk-dev.
 
-### 12. Bump open issues to the next release.
+##### Bump open issues to the next release.
 
 In the [GitHub milestone][gh-milestones], bump any open issues to the
 following release.
 
----
-=======
-Unlock a branch by changing the number of required approving reviewers back to 1.
->>>>>>> automate prerelease commit, clean up release guide
-
 
 [git]:https://git-scm.com/downloads
 [gpg2]:https://gnupg.org/download/
@@ -260,14 +259,6 @@ Unlock a branch by changing the number of required approving reviewers back to 1
 [netlify-deploy]:https://docs.netlify.com/site-deploys/overview/#deploy-summary
 [doc-owners]: https://github.com/operator-framework/operator-sdk/blob/master/OWNERS
 [release-page]:https://github.com/operator-framework/operator-sdk/releases
-<<<<<<< HEAD
-[homebrew]:https://brew.sh/
-[homebrew-formula]:https://github.com/Homebrew/homebrew-core/blob/master/Formula/operator-sdk.rb
-[homebrew-readme]:https://github.com/Homebrew/homebrew-core/blob/master/CONTRIBUTING.md#to-submit-a-version-upgrade-for-the-foo-formula
-[homebrew-repo]:https://github.com/Homebrew/homebrew-core
-[sdk-samples-repo]:https://github.com/operator-framework/operator-sdk-samples
+[backports]:/docs/upgrading-sdk-version/backport-policy
 [mailing-list]:https://groups.google.com/g/operator-framework
 [gh-milestones]:https://github.com/operator-framework/operator-sdk/milestones
-=======
-[backports]:/docs/upgrading-sdk-version/backport-policy
->>>>>>> automate prerelease commit, clean up release guide

website/scripts/set_version.sh

@@ -1,9 +1,19 @@
 #!/usr/bin/env bash
 
+# This script updates the hugo config's "version_menu" param
+# to the current ${MAJOR}.${MINOR} string.
+
 DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)"
+CONFIG_PATH="${DIR}/../config.toml"
 
 BRANCH_NAME="$(git rev-parse --abbrev-ref HEAD)"
 if [[ "$BRANCH_NAME" =~ v[0-9]+\.[0-9]+\.x ]]; then
   VERSION_MENU="$(echo $BRANCH_NAME | awk -F. '{ print v$1"."$2 }')"
-  sed -i -E 's/version_menu = ".+"/version_menu = "'${VERSION_MENU}'"/g' "${DIR}"/../config.toml
+  sed -i -E 's/version_menu = ".+"/version_menu = "'${VERSION_MENU}'"/g' "$CONFIG_PATH"
+
+  # Ensure config.toml was updated.
+  if ! grep -q "version_menu = \"${VERSION_MENU}\"" "$CONFIG_PATH"; then
+    echo "$0 failed to update config.toml"
+    exit 1
+  fi
 fi

website/scripts/update_mappings.sh

@@ -1,6 +1,10 @@
 #!/usr/bin/env bash
 
+# This script writes a branch-to-subdomain mapping for the previously created
+# release branch to the hugo config. This change should be committed in the prerelease commit.
+
 DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)"
+CONFIG_PATH="${DIR}/../config.toml"
 
 VERSION="${1?"A Version is required"}"
 VERSION_PATCHLESS="$(echo $VERSION | awk -F. '{ print v$1"."$2 }')"
@@ -14,4 +18,10 @@ fi
 MARKER="##RELEASE_ADDME##"
 PARAMS_VERSION="[[params.versions]]\\n  version = \"${VERSION_PATCHLESS}\"\\n  url = \"https://${VERSION_X_DOMAIN}.sdk.operatorframework.io\""
 
-sed -i -E $'s@'${MARKER}'@'"${MARKER}\\n\\n${PARAMS_VERSION}"'@g' "${DIR}"/../config.toml
+sed -i -E $'s@'${MARKER}'@'"${MARKER}\\n\\n${PARAMS_VERSION}"'@g' "$CONFIG_PATH"
+
+# Ensure config.toml was updated.
+if ! grep -q "url = \"https://${VERSION_X_DOMAIN}.sdk.operatorframework.io\"" "$CONFIG_PATH"; then
+  echo "$0 failed to update config.toml"
+  exit 1
+fi