Skip to content

Commit 0ff663e

Browse files
committed
minor-release: Document post-release update steps
After a vX.Y.0 minor release, we typically need to do a set of clean up around (a) the upgrade guide on `main`, which now refers to the latest stable release rather than being a placeholder for the upcoming development release, and (b) the oldest stable branch which becomes unmaintained following the new stable release. Document these steps. Signed-off-by: Joe Stringer <joe@cilium.io>
1 parent c276f69 commit 0ff663e

2 files changed

Lines changed: 20 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/release_template_minor.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,15 @@ assignees: ''
9494
- [ ] `echo '{"results":[{"slug":"vX.Y"}]}' > Documentation/_static/stable-version.json`.
9595
- [ ] Commit / amend the commit to add all of the changes above and push the PR.
9696
- [ ] Merge the post-release PR.
97+
- [ ] Update the upgrade guide and [roadmap] on the `main` branch to prepare
98+
for the next development cycle. References to vX.Y should be removed, but
99+
the upgrade guide structure should remain in place in order for
100+
developers to document the changes necessary for the next release.
101+
- [ ] The oldest maintained release branch will now no longer be maintained.
102+
Prepare an update PR for the `main` branch to remove references to that
103+
branch. This may involve modifying documentation, code comments and
104+
configuration for GitHub or Renovate.
105+
- `git grep vX.Y-1`
97106

98107
[release workflow]: https://github.com/cilium/cilium/actions/workflows/release.yaml
99108
[signing tags]: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-tags
@@ -109,4 +118,5 @@ assignees: ''
109118
[chart workflow]: https://github.com/cilium/charts/actions/workflows/validate-cilium-chart.yaml
110119
[Cilium charts]: https://github.com/cilium/charts
111120
[default version]: https://readthedocs.org/dashboard/cilium/advanced/
121+
[roadmap]: https://github.com/cilium/cilium/blob/main/Documentation/community/roadmap.rst
112122
[security policy]: https://github.com/cilium/cilium/security/policy

testdata/checklist/release_template_minor.md.golden

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

0 commit comments

Comments
 (0)