Skip to content

Commit

Permalink
add steps to prevent and allow main merge during the release procedure
Browse files Browse the repository at this point in the history
Signed-off-by: Shinya Hayashi <[email protected]>
  • Loading branch information
peng225 committed Aug 30, 2024
1 parent 6df6055 commit 80c0bbb
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,15 @@ The result should look something like:
Bump version
------------

1. Determine a new version number by [checking the differences](https://github.com/topolvm/pie/compare/vX.Y.Z...main) since the last release. Then, define the `VERSION` variable.
1. Go to [the rule setting page](https://github.com/topolvm/pie/settings/rules/1550843) and change the value of "Enforcement status" to `Active`.

2. Determine a new version number by [checking the differences](https://github.com/topolvm/pie/compare/vX.Y.Z...main) since the last release. Then, define the `VERSION` variable.

```console
VERSION=1.2.3
```

2. Add a new tag and push it.
3. Add a new tag and push it.

```console
git switch main
Expand All @@ -54,15 +56,15 @@ Bump version
git push origin v$VERSION
```

3. Once a new tag is pushed, [GitHub Actions][] automatically
4. 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/pie/releases to check
the result.

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

Expand All @@ -74,19 +76,23 @@ This will prevent the pie 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 by [checking the differences](https://github.com/topolvm/pie/compare/pie-chart-vX.Y.Z...main) since the last release. Then, manually run the workflow to create a PR to update the Helm Chart.
1. If necessary, go to [the rule setting page](https://github.com/topolvm/pie/settings/rules/1550843) and change the value of "Enforcement status" to `Active`.
- If you are here after releasing the app, you should already have this setting changed.

2. Determine a new version number by [checking the differences](https://github.com/topolvm/pie/compare/pie-chart-vX.Y.Z...main) since the last release. Then, manually run the workflow to create a PR to update the Helm Chart.

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

2. Review and merge the auto-created PR.
3. Review and merge the auto-created PR.
- Before merging, go to [the rule setting page](https://github.com/topolvm/pie/settings/rules/1550843) and change the value of "Enforcement status" to `Disabled`.

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

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

When you run workflow, [helm/chart-releaser-action](https://github.com/helm/chart-releaser-action) will automatically create a GitHub Release.

4. Edit the auto-generated release note as follows:
5. Edit the auto-generated release note as follows:
1. Select the "Previous tag", which is in the form of "pie-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.
Expand Down

0 comments on commit 80c0bbb

Please sign in to comment.