Split releases in two PRs (#24)

* release.sh: Added make regenerate-chart and split release and next into two PRs.

* Update README for the release script.

* Use different PR messages for release and bump PRs

* Update docs and tested.

Author: razvan

release/README.md

@@ -16,23 +16,27 @@ Optionally, if you want to have a GitHub Pull-Request automatically created, you
 
 ## Usage
 
-Go to the folder containing a Cargo workspace or crate and run:
+To make a release pull-request, go to the folder containing a Cargo workspace or crate and run:
 
-    release.sh [<next-devel-level>] [false]
+    release.sh release
 
-where `next-devel-level` is the version level to be increased *after* the release is done. This ca be `major`, `minor` or `patch`.
+To bump the version and create pull-request:
 
-This pushes two commits in a newly created release branch. When merging, __do not squash them__.
+    release.sh [<next-devel-level>]
+
+where `next-devel-level` is the version level to be bumped. This ca be `major`, `minor` or `patch`.
+
+This pushes two commits in a newly created release branch.
 
 Examples:
 
-    # Perform release and raise the minor version afterwards
-    $ release.sh
+    # Perform release
+    $ release.sh release
 
-    # Perform a release but do not push anything to origin
+    # Bump the minor version but do not push anything to origin
     $ release.sh minor false
 
-    # Perform a release and raise the major version for the next development version
+    # Bump the major version, push and make a pull-request
     $ release.sh major
 
 ## Description
@@ -41,13 +45,15 @@ The release process performs the following steps:
 0. Create a release branch from `main`.
 1. Update the release version in the cargo workspace by dropping the "-nightly" token.
 2. Update `Cargo.lock` with the new version.
-3. Commit and tag the release.
-4. Set the version to the next development version by increasing the 'minor' (by default) part and adding the '-nightly' prerelease token.
-5. Update `Cargo.lock` with the new version.
-6. Commit the next release.
-7. Push the two commits. This is skipped if the second argument was `false`.
-8. __Optional__: if the GitHub cli is installed, a PR is created.  This is also skipped if the second argument was `false`.
-
-## Future development
+3. Regenerate Helm chart and manifests.
+4. Update the CHANGELOG.md entry of this release
+5. Commit, tag and push the changes.
+6. __Optional__: if the GitHub cli is installed, a PR is created.
 
-Automatically update the change log and readme files.
+Raising the next development version includes the following steps:
+0. Create a release branch from `main`.
+1. Set the version to the next development version by increasing the 'next-devel-level' (by default) part and adding the '-nightly' prerelease token.
+2. Update `Cargo.lock` with the new version.
+3. Regenerate Helm chart and manifests.
+4. Commit and push
+5. __Optional__: if the GitHub cli is installed, a PR is created.

release/release.sh

@@ -1,10 +1,11 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 #
 # Usage: release.sh <level>
 #
 # <level> : "major", "minor" or "patch". Default: "minor".
 #
 set -e
+set -x
 
 BASE_BRANCH="main"
 REPOSITORY="origin"
@@ -26,10 +27,10 @@ ensure_release_branch() {
 }
 
 maybe_create_github_pr() {
-  local TAG=$1
+  local MESSAGE=${1}
   GH_COMMAND=$(which gh)
   if [ "$GH_COMMAND" != "" ]; then
-    gh pr create --base $BASE_BRANCH --head $RELEASE_BRANCH --title "Release $TAG" --body "Release $TAG. DO NOT SQUASH MERGE!"
+    gh pr create --base $BASE_BRANCH --head $RELEASE_BRANCH --title $MESSAGE --body $MESSAGE
   fi
 }
 
@@ -38,41 +39,49 @@ update_changelog() {
 
   TODAY=$(date +'%Y-%m-%d')
 
-  sed -i "s/^.*unreleased.*/## [Unreleased]\n\n## [$RELEASE_VERSION] - $TODAY\n/I" CHANGELOG.md
+  sed -i "s/^.*unreleased.*/## [Unreleased]\n\n## [$RELEASE_VERSION] - $TODAY/I" CHANGELOG.md
 }
 
 main() {
 
-  local NEXT_LEVEL=${1:-minor}
+  local NEXT_LEVEL=${1:-"release"}
   local PUSH=${2:-true}
 
   ensure_release_branch
 
-  #
-  # Release
-  #
-  $CARGO_VERSION --release
-  cargo update --workspace
-  local RELEASE_VERSION=$($CARGO_VERSION --show)
+  if [ "$NEXT_LEVEL" == "release" ]; then
+    #
+    # Release
+    #
+    $CARGO_VERSION --release
+    cargo update --workspace
+    make regenerate-charts
+    local RELEASE_VERSION=$($CARGO_VERSION --show)
+
+    update_changelog $RELEASE_VERSION
+
+    MESSAGE="release $RELEASE_VERSION"
+    git commit -am "release $RELEASE_VERSION"
+    git tag -a $RELEASE_VERSION -m "release $RELEASE_VERSION"
+
+  else
+    #
+    # Development
+    #
+    $CARGO_VERSION --next ${NEXT_LEVEL}
+    cargo update --workspace
+    make regenerate-charts
+    local RELEASE_VERSION=$($CARGO_VERSION --show)
+
+    MESSAGE="bump version $RELEASE_VERSION"
+    git commit -am "bump version $RELEASE_VERSION"
 
-  update_changelog $RELEASE_VERSION
-
-  git commit -am "bump version $RELEASE_VERSION"
-  git tag -a $RELEASE_VERSION -m "release $RELEASE_VERSION" HEAD
-
-  #
-  # Development
-  #
-  $CARGO_VERSION --next ${NEXT_LEVEL}
-  cargo update --workspace
-  local NEXT_TAG=$($CARGO_VERSION --show)
-
-  git commit -am "bump version $NEXT_TAG"
+  fi
 
   if [ "$PUSH" = "true" ]; then
     git push ${REPOSITORY} ${RELEASE_BRANCH} 
     git push --tags
-    maybe_create_github_pr $RELEASE_VERSION
+    maybe_create_github_pr $MESSAGE
     git switch main
   fi
 }