Skip to content

Commit fcfcd45

Browse files
aanmjoestringer
authored andcommitted
.github/templates: update instructions
Update release instructions to simplify running steps. Signed-off-by: André Martins <andre@cilium.io>
1 parent ab80ac6 commit fcfcd45

10 files changed

Lines changed: 58 additions & 57 deletions

.github/templates/release_template_minor.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ assignees: ''
4949
- [ ] Run `./release start --steps 3-tag --target-version vX.Y.0`
5050
- [ ] Ask a maintainer to approve the build in the following link (keep the URL
5151
of the GitHub run to be used later):
52-
[Cilium Image Release builds](https://github.com/cilium/cilium/actions?query=workflow:%22Image+Release+Build%22)
52+
[Cilium Image Release builds](https://github.com/cilium/cilium/actions/workflows/build-images-releases.yaml)
5353

5454
## Post Tagging (run after docker images are published. In case of failure, this step can be re-run multiple times.)
5555

@@ -59,12 +59,13 @@ assignees: ''
5959

6060
## Publish helm (run after docker images are published. In case of failure, this step can be re-run multiple times.)
6161

62-
- [ ] Ask a maintainer to approve the build in the following link:
63-
[Release Tool](https://github.com/cilium/cilium/actions/workflows/release.yaml)
62+
- [ ] Ask a maintainer to approve the `release-helm` deployment in the GitHub
63+
URL of the run kept from the "Tagging" step. ([Cilium Image Release builds](https://github.com/cilium/cilium/actions/workflows/build-images-releases.yaml))
6464
- [ ] Check if the image build process was successful and check if the helm
6565
chart was published by the Release bot under the [Cilium helm charts][Cilium charts].
66-
If the PR was not opened, you can safely re-run the failed job.
67-
- [ ] Open [Charts Workflow] and check if the workflow run is successful for vX.Y.0.
66+
If that did not happen, you can safely re-run the failed job.
67+
- [ ] Open [Cilium helm Chart Workflow][Charts Workflow] and check if the
68+
workflow run is successful for vX.Y.0.
6869

6970
## Publish docs
7071

@@ -104,7 +105,7 @@ assignees: ''
104105
Prepare an update PR for the `main` branch to remove references to that
105106
branch. This may involve modifying documentation, code comments and
106107
configuration for GitHub or Renovate.
107-
- `git grep vX.Y-1`
108+
- `git grep vX.Y-2`
108109
- [ ] Update the [Cilium Wikipedia] release timeline table to reflect the new
109110
version. Ensure the version, release date, and any notable changes are
110111
accurately represented in the table and graph.
@@ -120,7 +121,7 @@ assignees: ''
120121
[read the docs]: https://readthedocs.org/projects/cilium/
121122
[active versions]: https://readthedocs.org/projects/cilium/versions/?version_filter=vX.Y
122123
[docsearch-scraper-webhook]: https://github.com/cilium/docsearch-scraper-webhook
123-
[chart workflow]: https://github.com/cilium/charts/actions/workflows/validate-cilium-chart.yaml
124+
[Charts Workflow]: https://github.com/cilium/charts/actions/workflows/validate-cilium-chart.yaml
124125
[Cilium charts]: https://github.com/cilium/charts
125126
[default version]: https://readthedocs.org/dashboard/cilium/advanced/
126127
[roadmap]: https://github.com/cilium/cilium/blob/main/Documentation/community/roadmap.rst

.github/templates/release_template_patch.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ assignees: ''
5454
- [ ] Run `./release start --steps 3-tag --target-version vX.Y.Z`
5555
- [ ] Ask a maintainer to approve the build in the following link (keep the URL
5656
of the GitHub run to be used later):
57-
[Cilium Image Release builds](https://github.com/cilium/cilium/actions?query=workflow:%22Image+Release+Build%22)
57+
[Cilium Image Release builds](https://github.com/cilium/cilium/actions/workflows/build-images-releases.yaml)
5858

5959
## Post Tagging (run after docker images are published. In case of failure, this step can be re-run multiple times.)
6060

@@ -66,12 +66,13 @@ assignees: ''
6666

6767
## Publish helm (run after docker images are published. In case of failure, this step can be re-run multiple times.)
6868

69-
- [ ] Ask a maintainer to approve the build in the following link:
70-
[Release Tool](https://github.com/cilium/cilium/actions/workflows/release.yaml)
69+
- [ ] Ask a maintainer to approve the `release-helm` deployment in the GitHub
70+
URL of the run kept from the "Tagging" step. ([Cilium Image Release builds](https://github.com/cilium/cilium/actions/workflows/build-images-releases.yaml))
7171
- [ ] Check if the image build process was successful and check if the helm
7272
chart was published by the Release bot under the [Cilium helm charts][Cilium charts].
7373
If that did not happen, you can safely re-run the failed job.
74-
- [ ] Open [Charts Workflow] and check if the workflow run is successful for vX.Y.Z.
74+
- [ ] Open [Cilium helm Chart Workflow][Charts Workflow] and check if the
75+
workflow run is successful for vX.Y.Z.
7576

7677
## Post-release
7778

.github/templates/release_template_pre_main.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ assignees: ''
5454
- [ ] Run `./release start --steps 3-tag --target-version vX.Y.Z-pre.N`
5555
- [ ] Ask a maintainer to approve the build in the following link (keep the URL
5656
of the GitHub run to be used later):
57-
[Cilium Image Release builds](https://github.com/cilium/cilium/actions?query=workflow:%22Image+Release+Build%22)
57+
[Cilium Image Release builds](https://github.com/cilium/cilium/actions/workflows/build-images-releases.yaml)
5858

5959
## Post Tagging (run after docker images are published. In case of failure, this step can be re-run multiple times.)
6060

@@ -63,12 +63,13 @@ assignees: ''
6363

6464
## Publish helm (run after docker images are published. In case of failure, this step can be re-run multiple times.)
6565

66-
- [ ] Ask a maintainer to approve the build in the following link:
67-
[Release Tool](https://github.com/cilium/cilium/actions/workflows/release.yaml)
66+
- [ ] Ask a maintainer to approve the `release-helm` deployment in the GitHub
67+
URL of the run kept from the "Tagging" step. ([Cilium Image Release builds](https://github.com/cilium/cilium/actions/workflows/build-images-releases.yaml))
6868
- [ ] Check if the image build process was successful and check if the helm
6969
chart was published by the Release bot under the [Cilium helm charts][Cilium charts].
7070
If that did not happen, you can safely re-run the failed job.
71-
- [ ] Open [Charts Workflow] and check if the workflow run is successful for vX.Y.Z-pre.N.
71+
- [ ] Open [Cilium helm Chart Workflow][Charts Workflow] and check if the
72+
workflow run is successful for vX.Y.Z-pre.N.
7273

7374
## Publish docs (only for pre/rc releases)
7475

.github/templates/release_template_rc_branch.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -269,28 +269,23 @@ assignees: ''
269269
- [ ] Run `./release start --steps 3-tag --target-version vX.Y.Z-rc.W`
270270
- [ ] Ask a maintainer to approve the build in the following link (keep the URL
271271
of the GitHub run to be used later):
272-
[Cilium Image Release builds](https://github.com/cilium/cilium/actions?query=workflow:%22Image+Release+Build%22)
272+
[Cilium Image Release builds](https://github.com/cilium/cilium/actions/workflows/build-images-releases.yaml)
273273
274274
## Post Tagging (run after docker images are published. In case of failure, this step can be re-run multiple times.)
275275
276276
- [ ] Check if the image build process was successful and check the PR opened
277-
by the Release bot. If the PR was not opened, you can re-run the workflow
278-
- **IN CASE THE PR WAS NOT OPENED** Go to [release workflow] and Run the
279-
workflow from "Branch: main", for step "4-post-release" and version for
280-
vX.Y.Z-rc.W
277+
by the Release bot. If the PR was not opened, you can safely re-run the failed job.
281278
- [ ] Merge PR
282279
283280
## Publish helm (run after docker images are published. In case of failure, this step can be re-run multiple times.)
284281
285-
- [ ] Ask a maintainer to approve the build in the following link:
286-
[Release Tool](https://github.com/cilium/cilium/actions/workflows/release.yaml)
282+
- [ ] Ask a maintainer to approve the `release-helm` deployment in the GitHub
283+
URL of the run kept from the "Tagging" step. ([Cilium Image Release builds](https://github.com/cilium/cilium/actions/workflows/build-images-releases.yaml))
287284
- [ ] Check if the image build process was successful and check if the helm
288285
chart was published by the Release bot under the [Cilium helm charts][Cilium charts].
289-
If that did not happen, you can re-run the workflow.
290-
- **IN CASE THE HELM CHART WAS NOT PUSHED** Go to [release workflow]
291-
and Run the workflow from "Branch: main", for step "5-publish-helm" and
292-
version for vX.Y.Z-rc.W
293-
- [ ] Open [chart workflow] and check if the workflow run is successful for vX.Y.Z-rc.W.
286+
If that did not happen, you can safely re-run the failed job.
287+
- [ ] Open [Cilium helm Chart Workflow][Charts Workflow] and check if the
288+
workflow run is successful for vX.Y.Z-rc.W.
294289
295290
## Publish docs (only for pre/rc releases)
296291
@@ -350,7 +345,7 @@ Thank you for the testing and contributing to the previous pre-releases. There a
350345
[read the docs]: https://readthedocs.org/projects/cilium/
351346
[active versions]: https://readthedocs.org/projects/cilium/versions/?version_filter=vX.Y.Z-rc.W
352347
[docsearch-scraper-webhook]: https://github.com/cilium/docsearch-scraper-webhook
353-
[chart workflow]: https://github.com/cilium/charts/actions/workflows/validate-cilium-chart.yaml
348+
[Charts Workflow]: https://github.com/cilium/charts/actions/workflows/validate-cilium-chart.yaml
354349
[Cilium charts]: https://github.com/cilium/charts
355350
[Review feature PRs]: https://github.com/cilium/cilium/pulls?q=is%3Aopen+base%3Amain+is%3Apr+-label%3Arelease-note%2Fbug+-label%3Arelease-note%2Fci+-author%3Aapp%2Fcilium-renovate+-label%3Adont-merge%2Fwait-until-release+-label%3Adont-merge%2Fpreview-only+-label%3Aarea%2Fdocumentation+-label%3Acilium-cli-exclusive+-label%3Arelease-blocker%2FX.Y
356351
[Renovate PRs]: https://github.com/cilium/cilium/pulls?q=is%3Aopen+is%3Apr+author%3Aapp%2Fcilium-renovate+base%3Amain

cmd/checklist/template.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
gh "github.com/google/go-github/v62/github"
1414
"golang.org/x/mod/semver"
1515

16-
templates "github.com/cilium/release/.github/templates"
16+
"github.com/cilium/release/.github/templates"
1717
)
1818

1919
var (
@@ -22,6 +22,7 @@ var (
2222
"X.Y.Z-pre.N",
2323
"X.Y.Z",
2424
"X.Y.W",
25+
"X.Y-2",
2526
"X.Y-1",
2627
"X.Y+1",
2728
"X.Y",
@@ -80,6 +81,7 @@ func assembleVersionSubstitutions(version string) ([]string, error) {
8081
}
8182

8283
versionSub["X.Y.W"] = semver.MajorMinor(version) + "." + strconv.Itoa(patch+1)
84+
versionSub["X.Y-2"] = semver.Major(version) + "." + strconv.Itoa(minor-2)
8385
versionSub["X.Y-1"] = semver.Major(version) + "." + strconv.Itoa(minor-1)
8486
versionSub["X.Y+1"] = semver.Major(version) + "." + strconv.Itoa(minor+1)
8587
versionSub["X.Y"] = semver.MajorMinor(version)

cmd/checklist/template_test.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ func Test_assembleVersionSubstitutions(t *testing.T) {
3333
"X.Y.Z-pre.N", "",
3434
"X.Y.Z", "1.10.0",
3535
"X.Y.W", "1.10.1",
36+
"X.Y-2", "1.8",
3637
"X.Y-1", "1.9",
3738
"X.Y+1", "1.11",
3839
"X.Y", "1.10",
@@ -46,6 +47,7 @@ func Test_assembleVersionSubstitutions(t *testing.T) {
4647
"X.Y.Z-pre.N", "1.10.0-rc.0",
4748
"X.Y.Z", "1.10.0",
4849
"X.Y.W", "1.10.1",
50+
"X.Y-2", "1.8",
4951
"X.Y-1", "1.9",
5052
"X.Y+1", "1.11",
5153
"X.Y", "1.10",
@@ -59,6 +61,7 @@ func Test_assembleVersionSubstitutions(t *testing.T) {
5961
"X.Y.Z-pre.N", "1.10.0-pre.0",
6062
"X.Y.Z", "1.10.0",
6163
"X.Y.W", "1.10.1",
64+
"X.Y-2", "1.8",
6265
"X.Y-1", "1.9",
6366
"X.Y+1", "1.11",
6467
"X.Y", "1.10",

testdata/checklist/release_template_minor.md.golden

Lines changed: 8 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

testdata/checklist/release_template_patch.md.golden

Lines changed: 5 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

testdata/checklist/release_template_pre_main.md.golden

Lines changed: 5 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

testdata/checklist/release_template_rc_branch.md.golden

Lines changed: 8 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)