Skip to content

Commit 80c0bbb

Browse files
committed
add steps to prevent and allow main merge during the release procedure
Signed-off-by: Shinya Hayashi <[email protected]>
1 parent 6df6055 commit 80c0bbb

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

RELEASE.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,15 @@ The result should look something like:
3939
Bump version
4040
------------
4141

42-
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.
42+
1. Go to [the rule setting page](https://github.com/topolvm/pie/settings/rules/1550843) and change the value of "Enforcement status" to `Active`.
43+
44+
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.
4345

4446
```console
4547
VERSION=1.2.3
4648
```
4749

48-
2. Add a new tag and push it.
50+
3. Add a new tag and push it.
4951

5052
```console
5153
git switch main
@@ -54,15 +56,15 @@ Bump version
5456
git push origin v$VERSION
5557
```
5658

57-
3. Once a new tag is pushed, [GitHub Actions][] automatically
59+
4. Once a new tag is pushed, [GitHub Actions][] automatically
5860
creates a draft release note for the tagged version,
5961
builds a tar archive for the new release,
6062
and attaches it to the release note.
6163
6264
Visit https://github.com/topolvm/pie/releases to check
6365
the result.
6466

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

@@ -74,19 +76,23 @@ This will prevent the pie version from going up just by modifying the Helm Chart
7476

7577
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.
7678

77-
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.
79+
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`.
80+
- If you are here after releasing the app, you should already have this setting changed.
81+
82+
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.
7883

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

81-
2. Review and merge the auto-created PR.
86+
3. Review and merge the auto-created PR.
87+
- 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`.
8288

83-
3. Manually run the GitHub Actions workflow for the release.
89+
4. Manually run the GitHub Actions workflow for the release.
8490

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

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

89-
4. Edit the auto-generated release note as follows:
95+
5. Edit the auto-generated release note as follows:
9096
1. Select the "Previous tag", which is in the form of "pie-chart-vX.Y.Z".
9197
2. Clear the textbox, and click "Generate release notes" button.
9298
3. Remove PRs which do not contain changes to the helm chart.

0 commit comments

Comments
 (0)