Skip to content

Commit

Permalink
Merge pull request #18 from cybozu-go/update-20220713
Browse files Browse the repository at this point in the history
Update release procedure
  • Loading branch information
masa213f authored Jul 13, 2022
2 parents 3cebe91 + 01d81a7 commit ef7cb67
Showing 1 changed file with 37 additions and 7 deletions.
44 changes: 37 additions & 7 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,18 @@ 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.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.
Expand All @@ -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.z
$ 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"
```

Expand All @@ -64,29 +79,44 @@ 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=a.b.c
$ 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
```

5. Merge this branch.
6. Add a git tag to the main HEAD, then push it.

```console
# Set CHARTVERSION again.
$ CHARTVERSION=a.b.c
$ 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.
Expand Down

0 comments on commit ef7cb67

Please sign in to comment.