From c2191ec2fc3bc7d7ce7ed18ac2d3e1a336936bed Mon Sep 17 00:00:00 2001 From: Masayuki Ishii Date: Wed, 13 Jul 2022 01:07:22 +0000 Subject: [PATCH 1/2] Update release procedure Signed-off-by: Masayuki Ishii --- docs/release.md | 42 ++++++++++++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 6 deletions(-) diff --git a/docs/release.md b/docs/release.md index b4f80c6..8b6082a 100644 --- a/docs/release.md +++ b/docs/release.md @@ -30,7 +30,14 @@ It should look like: ## Bump version -1. Determine a new version number. Let it write `$VERSION` as `VERSION=x.y.z`. +1. Determine a new version number. Then set `VERSION` variable. + + ```console + # Set VERSION and confirm it. It should not have "v" prefix. + $ VERSION=x.y.x + $ echo $VERSION + ``` + 2. Make a branch to release ```console @@ -50,9 +57,17 @@ It should look like: 7. Add a git tag to the main HEAD, then push it. ```console + # Set VERSION again. + $ VERSION=x.y.x + $ echo $VERSION + $ git checkout main $ git pull $ git tag -a -m "Release v$VERSION" "v$VERSION" + + # Make sure the release tag exists. + $ git tag -ln | grep $VERSION + $ git push origin "v$VERSION" ``` @@ -64,18 +79,25 @@ create a new GitHub release. Cattage Helm Chart will be released independently of Cattage itself. This will prevent the Cattage version from going up just by modifying the Helm Chart. -1. Determine a new version number of the chart. This version is not related to the version of Cattage. Let it write `$VERSION` as `VERSION=x.y.z`. +1. Determine a new version number of the chart. This version is not related to the version of Cattage. + + ```console + # Set CHARTVERSION and confirm it. It should not have "v" prefix. + $ CHARTVERSION=x.y.x + $ echo $CHARTVERSION + ``` + 2. Make a branch to release ```console - $ git neco dev "bump-chart-$VERSION"` + $ git neco dev "bump-chart-$CHARTVERSION"` ``` 3. Change the version of `Chart.yaml`. 4. Commit the change and push it. ```console - $ git commit -a -m "Bump chart version to $VERSION" + $ git commit -a -m "Bump chart version to $CHARTVERSION" $ git neco review ``` @@ -83,10 +105,18 @@ This will prevent the Cattage version from going up just by modifying the Helm C 6. Add a git tag to the main HEAD, then push it. ```console + # Set CHARTVERSION again. + $ CHARTVERSION=x.y.x + $ echo $CHARTVERSION + $ git checkout main $ git pull - $ git tag -a -m "Release Chart v$VERSION" "chart-v$VERSION" - $ git push origin "chart-v$VERSION" + $ git tag -a -m "Release Chart v$CHARTVERSION" "chart-v$CHARTVERSION" + + # Make sure the release tag exists. + $ git tag -ln | grep $CHARTVERSION + + $ git push origin "chart-v$CHARTVERSION" ``` GitHub actions will upload the chart archive on `gh-pages` branch. From 01d81a751f8f52dd0be9e8349f91f3661c873216 Mon Sep 17 00:00:00 2001 From: Masayuki Ishii Date: Wed, 13 Jul 2022 08:31:26 +0000 Subject: [PATCH 2/2] fix typo Signed-off-by: Masayuki Ishii --- docs/release.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/release.md b/docs/release.md index 8b6082a..0c8ca35 100644 --- a/docs/release.md +++ b/docs/release.md @@ -34,14 +34,14 @@ It should look like: ```console # Set VERSION and confirm it. It should not have "v" prefix. - $ VERSION=x.y.x + $ VERSION=x.y.z $ echo $VERSION ``` 2. Make a branch to release ```console - $ git neco dev "bump-$VERSION"` + $ git neco dev "bump-$VERSION" ``` 3. Update version strings in `version.go` in the top directory. @@ -58,7 +58,7 @@ It should look like: ```console # Set VERSION again. - $ VERSION=x.y.x + $ VERSION=x.y.z $ echo $VERSION $ git checkout main @@ -83,14 +83,14 @@ This will prevent the Cattage version from going up just by modifying the Helm C ```console # Set CHARTVERSION and confirm it. It should not have "v" prefix. - $ CHARTVERSION=x.y.x + $ CHARTVERSION=a.b.c $ echo $CHARTVERSION ``` 2. Make a branch to release ```console - $ git neco dev "bump-chart-$CHARTVERSION"` + $ git neco dev "bump-chart-$CHARTVERSION" ``` 3. Change the version of `Chart.yaml`. @@ -106,7 +106,7 @@ This will prevent the Cattage version from going up just by modifying the Helm C ```console # Set CHARTVERSION again. - $ CHARTVERSION=x.y.x + $ CHARTVERSION=a.b.c $ echo $CHARTVERSION $ git checkout main