Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 2.85 KB

RELEASE.md

File metadata and controls

94 lines (61 loc) · 2.85 KB
Raw

Release procedure

This document describes how to release a new version of TopoLVM.

Versioning

Follow semantic versioning 2.0.0 to choose the new version number.

The format of release notes

In the release procedure for both the app and Helm Chart, the release note is generated automatically, and then it is edited manually. In this step, PRs should be classified based on Keep a CHANGELOG.

The result should look something like:

## What's Changed

### 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)

Bump version

  1. Determine a new version number by checking the differences since the last release. Then, define the VERSION variable.

    VERSION=1.2.3

  2. Add a new tag and push it.

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

  3. Once a new tag is pushed, GitHub Actions automatically creates a draft release note for the tagged version, builds a tar archive for the new release, and attaches it to the release note.

    Visit https://github.com/topolvm/topolvm/releases to check the result.

  4. Edit the auto-generated release note and remove PRs which contain changes only to the helm chart. Then, publish it.

Bump Chart Version

TopoLVM Helm Chart will be released independently. This will prevent the TopoLVM version from going up just by modifying the Helm Chart.

  1. Determine a new version number by checking the differences since the last release. Then, manually run the workflow to create a PR to update the Helm Chart.

    https://github.com/topolvm/topolvm/actions/workflows/create-chart-update-pr.yaml

  2. Review and merge the auto-created PR.

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

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

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

  4. Edit the auto-generated release note as follows:

    1. Select the "Previous tag", which is in the form of "topolvm-chart-vX.Y.Z".
    2. Clear the textbox, and click "Generate release notes" button.
    3. Remove PRs which do not contain changes to the helm chart.