diff --git a/CHANGELOG.md b/CHANGELOG.md index 9115790..c882fdc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,9 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] -### Added -### Changed -### Removed +## [0.1.0] - 2022-02-10 -[Unreleased]: https://github.com/cybozu-go/neco-template/compare/4b825dc642cb6eb9a060e54bf8d69288fbee4904...HEAD +This is the first public release. + +[Unreleased]: https://github.com/cybozu-go/cattage/compare/v0.1.0...HEAD +[0.1.0]: https://github.com/cybozu-go/cattage/compare/60bcea7b1cf9d79e5e439d0fa7dbb4629c9f1125...v0.1.0 diff --git a/docs/release.md b/docs/release.md index aae10a9..b4f80c6 100644 --- a/docs/release.md +++ b/docs/release.md @@ -34,19 +34,20 @@ It should look like: 2. Make a branch to release ```console - $ git neco dev "$VERSION"` + $ git neco dev "bump-$VERSION"` ``` -3. Edit `CHANGELOG.md` for the new version ([example][]). -4. Commit the change and push it. +3. Update version strings in `version.go` in the top directory. +4. Edit `CHANGELOG.md` for the new version ([example][]). +5. Commit the change and push it. ```console $ git commit -a -m "Bump version to $VERSION" $ git neco review ``` -5. Merge this branch. -6. Add a git tag to the main HEAD, then push it. +6. Merge this branch. +7. Add a git tag to the main HEAD, then push it. ```console $ git checkout main @@ -58,5 +59,37 @@ It should look like: GitHub actions will build and push artifacts such as container images and create a new GitHub release. +## Release Helm Chart + +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`. +2. Make a branch to release + + ```console + $ git neco dev "bump-chart-$VERSION"` + ``` + +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 neco review + ``` + +5. Merge this branch. +6. Add a git tag to the main HEAD, then push it. + + ```console + $ git checkout main + $ git pull + $ git tag -a -m "Release Chart v$VERSION" "chart-v$VERSION" + $ git push origin "chart-v$VERSION" + ``` + +GitHub actions will upload the chart archive on `gh-pages` branch. + [semver]: https://semver.org/spec/v2.0.0.html [example]: https://github.com/cybozu-go/etcdpasswd/commit/77d95384ac6c97e7f48281eaf23cb94f68867f79