Skip to content

Latest commit

 

History

History
162 lines (115 loc) · 5.02 KB

RELEASE.md

File metadata and controls

162 lines (115 loc) · 5.02 KB

Release procedure

This document describes how to release a new version of pvc-autoresizer.

Versioning

Follow semantic versioning 2.0.0 to choose the new version number.

Prepare change log entries

Add notable changes since the last release to CHANGELOG.md. It should look like:

(snip)
## [Unreleased]

### Added
- Add a notable feature for users (#35)

### Changed
- Change a behavior affecting users (#33)

### Removed
- Remove a feature, users action required (#39)

### Fixed
- Fix something not affecting users or a minor change (#40)

### Contributors
- @hoge
- @foo

(snip)

Bump version

  1. Determine a new version number. Export it as an environment variable:

    $ VERSION=1.2.3
$ export VERSION

  2. Make a branch for the release as follows:

    $ git checkout main
$ git pull
$ git checkout -b bump-$VERSION

  3. Edit CHANGELOG.md for the new version (example). The candidate of relevant PRs can be obtained by the following command.

    git log --merges --format="%s%x00%b" $(git tag | grep "^v" | sort -V -r | head -n 1)..main | sed -E 's|^Merge pull request #([0-9]*)[^\x0]*\x0(.*)|- \2 ([#\1](https://github.com/topolvm/pvc-autoresizer/pull/\1))|' | tac

    Please remove PRs which contain changes only to the helm chart.

  4. Edit config/default/kustomization.yaml and update newTag value for the new version.

    $ sed -i -s "s/newTag:.*/newTag: ${VERSION}/" config/default/kustomization.yaml

  5. Change TOPOLVM_VERSION in e2e/Makefile to the latest topolvm chart release tag. (e.g. topolvm-chart-vX.Y.Z)

  6. Commit the change and create a pull request:

    $ git commit -a -s -m "Bump version to $VERSION"
$ git push -u origin bump-$VERSION

  7. Merge the new pull request.

  8. Add a new tag and push it as follows:

    $ git checkout main
$ git pull
$ git tag v$VERSION
$ git push origin v$VERSION

Publish GitHub release page

Once a new tag is pushed to GitHub, GitHub Actions automatically builds a tar archive for the new release, and uploads it to GitHub releases page.

Visit https://github.com/topolvm/pvc-autoresizer/releases to check the result. You may manually edit the page to describe the release.

Release Helm Chart

pvc-autoresizer Helm Chart will be released independently from pvc-autoresizer's release. This will prevent the pvc-autoresizer version from going up just by modifying the Helm Chart.

You must change the version of Chart.yaml when making changes to the Helm Chart. CI fails with lint error when creating a Pull Request without changing the version of Chart.yaml.

  1. Determine a new version number. Export it as an environment variable:

    $ APPVERSION=1.2.3
$ export APPVERSION
$ CHARTVERSION=1.2.3
$ export CHARTVERSION

  2. Make a branch for the release as follows:

    $ git checkout main
$ git pull
$ git checkout -b bump-chart-$CHARTVERSION

  3. Update image and chart versions in files below:

    • charts/pvc-autoresizer/Chart.yaml
    • charts/pvc-autoresizer/values.yaml
    $ sed -r -i "s/^version: [[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+/version: ${CHARTVERSION}/g" charts/pvc-autoresizer/Chart.yaml
$ sed -r -i "s/appVersion: [[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+/appVersion: ${APPVERSION}/g" charts/pvc-autoresizer/Chart.yaml
$ sed -r -i "s/ghcr.io\/topolvm\/pvc-autoresizer:[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+/ghcr.io\/topolvm\/pvc-autoresizer:${APPVERSION}/g" charts/pvc-autoresizer/Chart.yaml
$ sed -r -i "s/tag:  # [[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+/tag:  # ${APPVERSION}/g" charts/pvc-autoresizer/values.yaml

  4. Edit charts/pvc-autoresizer/CHANGELOG.md for the new version. The candidate of relevant PRs can be obtained by the following command.

    git log --merges --format="%s%x00%b" $(git tag | grep "^pvc-autoresizer-chart-v" | sort -V -r | head -n 1)..main | sed -E 's|^Merge pull request #([0-9]*)[^\x0]*\x0(.*)|- \2 ([#\1](https://github.com/topolvm/pvc-autoresizer/pull/\1))|' | tac

    Please select PRs which contain changes to the helm chart.

  5. Commit the change and create a pull request:

    $ git commit -a -s -m "Bump chart version to $CHARTVERSION"
$ git push -u origin bump-chart-$CHARTVERSION

  6. Create new pull request and merge it.

  7. Manually run the GitHub Actions workflow for the release.

    https://github.com/topolvm/pvc-autoresizer/actions/workflows/helm-release.yaml

    When you run workflow, helm/chart-releaser-action will automatically create a GitHub Release.