[x] Depending on your OS, make sure Docker is running
[x] Export a GITHUB_TOKEN that has access to the repository
[x] Make sure a setup (GPG, SSH, S/MIME) is in place for [signing tags] with Git
[ ] Make sure the GOPATH environment variable is set and pointing to the relevant path
[x] Make sure the [Cilium helm charts][Cilium charts] repository is installed locally:
[x] Run git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"
Pre-release
[x] Announce in Cilium slack channel #launchpad: Starting v1.16.0-rc.2 release process :ship:
[x] Create a thread for that message and ping current top-hat to not merge any
PRs until the release process is complete.
[x] Change directory to the local copy of Cilium repository.
[x] Check that there are no [release blockers] for the targeted release version
[x] Ensure that outstanding [backport PRs] are merged
[x] Push a PR including the changes necessary for the new release:
[x] Run ../release/internal/start-release.sh v1.16.0-rc.2
Note that this script produces some files at the root of the Cilium
repository, and that these files are required at a later step for
tagging the release.
[x] Check the modified schema file(s) in Documentation as it will be
necessary to fix them manually. Add a new line for this RC and remove
unsupported versions.
[ ] Fix any duplicate AUTHORS entries and verify if it is possible to
get the real names instead of GitHub usernames.
[x] Add the generated CHANGELOG.md file and commit all remaining changes
with the title Prepare for release v1.16.0-rc.2
[x] Ping current top-hat that PRs can be merged again.
[x] Create and push both tags to GitHub (v1.16.0-rc.2, 1.16.0-rc.2)
Pull latest branch locally.
Check out the release commit and run ../release/internal/tag-release.sh
against that commit.
[x] Ask a maintainer to approve the build in the following link (keep the URL
of the GitHub run to be used later):
Cilium Image Release builds
[x] Check if all docker images are available before announcing the release:
make -C install/kubernetes/ RELEASE=yes CILIUM_BRANCH=v1.16 check-docker-images
[x] Get the image digests from the build process and make a commit and PR with
these digests.
[x] Run ../release/internal/post-release.sh URL to fetch the image
digests and submit a PR to update these, use the URL of the GitHub
run here
[x] Get someone to review the PR. Do not trigger the full CI suite, but
wait for the automatic checks to complete. Merge the PR.
[x] Update helm charts
[x] Create helm charts artifacts in [Cilium charts] repository using
[cilium helm release tool] for the v1.16.0-rc.2 release and push these
changes into the helm repository.
[x] Check the output of the [chart workflow] and see if the test was
successful.
[x] Check [read the docs] configuration:
[x] Set a new build as active and hidden in [active versions].
[x] Deactivate previous RCs.
[x] Update algolia configuration search in [docsearch-scraper-webhook].
Update the versions in docsearch.config.json, commit them and push a trigger the workflow here
[x] Check draft release from [releases] page
[x] Update the text at the top with 2-3 highlights of the release
[x] Publish the release
[x] Announce the release in #general on Slack.
Text template for the first RC:
This is the first monthly snapshot for the v1.16 development cycle. There are v1.16.0-rc.2 OSS docs available if you want to pull this version & try it out.
Thank you for the testing and contributing to the previous pre-releases. There are v1.16.0-rc.2 OSS docs available if you want to pull this version & try it out.
- [x] Bump the development snapshot version in `README.rst` on the main branch
to point to this release
- [x] Prepare post-release changes to main branch using `../release/internal/bump-readme.sh`.
- [x] Update the upgrade guide and [roadmap](https://github.com/cilium/cilium/blob/main/Documentation/community/roadmap.rst) for any features that changed status.
[signing tags]: https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-tags
[release blockers]: https://github.com/cilium/cilium/labels/release-blocker%2F1.16
[backport PRs]: https://github.com/cilium/cilium/pulls?q=is%3Aopen+is%3Apr+label%3Abackport%2F1.16
[Cilium charts]: https://github.com/cilium/charts
[releases]: https://github.com/cilium/cilium/releases
[cilium helm release tool]: https://github.com/cilium/charts/blob/master/RELEASE.md
[cilium-runtime images]: https://quay.io/repository/cilium/cilium-runtime
[read the docs]: https://readthedocs.org/projects/cilium/
[active versions]: https://readthedocs.org/projects/cilium/versions/?version_filter=v1.16.0-rc.2
[docsearch-scraper-webhook]: https://github.com/cilium/docsearch-scraper-webhook
[chart workflow]: https://github.com/cilium/charts/actions/workflows/validate-cilium-chart.yaml
Setup preparation
GITHUB_TOKEN
that has access to the repositoryGOPATH
environment variable is set and pointing to the relevant pathgit clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"
Pre-release
Starting v1.16.0-rc.2 release process :ship:
../release/internal/start-release.sh v1.16.0-rc.2
Note that this script produces some files at the root of the Cilium repository, and that these files are required at a later step for tagging the release.Documentation
as it will be necessary to fix them manually. Add a new line for this RC and remove unsupported versions.AUTHORS
entries and verify if it is possible to get the real names instead of GitHub usernames.CHANGELOG.md
file and commit all remaining changes with the titlePrepare for release v1.16.0-rc.2
../release/internal/submit-release.sh
)v1.16.0-rc.2
,1.16.0-rc.2
)../release/internal/tag-release.sh
against that commit.make -C install/kubernetes/ RELEASE=yes CILIUM_BRANCH=v1.16 check-docker-images
../release/internal/post-release.sh URL
to fetch the image digests and submit a PR to update these, use theURL
of the GitHub run herev1.16.0-rc.2
release and push these changes into the helm repository.docsearch.config.json
, commit them and push a trigger the workflow here:cilium-new: Cilium release candidate v1.16.0-rc.2 has been released: https://github.com/cilium/cilium/releases/tag/v1.16.0-rc.2
This is the first monthly snapshot for the v1.16 development cycle. There are v1.16.0-rc.2 OSS docs available if you want to pull this version & try it out.
Announcement :tada: :tada:
:cilium-new: Cilium release candidate v1.16.0-rc.2 has been released: https://github.com/cilium/cilium/releases/tag/v1.16.0-rc.2
Thank you for the testing and contributing to the previous pre-releases. There are v1.16.0-rc.2 OSS docs available if you want to pull this version & try it out.