[ ] Depending on your OS, make sure Docker is running
[ ] Export a GITHUB_TOKEN that has access to the repository
[ ] 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
[ ] Make sure the [Cilium helm charts][Cilium charts] repository is installed locally:
[ ] Run git clone https://github.com/cilium/charts.git "$GOPATH/src/github.com/cilium/charts"
Pre-release
[ ] Announce in Cilium slack channel #launchpad: Starting v1.17.0-pre.0 release process :ship:
[ ] Create a thread for that message and ping current top-hat to not merge any
PRs until the release process is complete.
[ ] Change directory to the local copy of Cilium repository.
[ ] Check that there are no [release blockers] for the targeted release version
[x] Push a PR including the changes necessary for the new release:
[ ] Run ../release/internal/start-release.sh v1.17.0-pre.0
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.
[ ] Fix any duplicate AUTHORS entries and verify if it is possible to
get the real names instead of GitHub usernames.
[ ] Commit the AUTHORS as well as the documentation files changed by the
previous step with title update AUTHORS and Documentation.
[ ] Add the generated CHANGELOG.md file and commit all remaining changes
with the title Prepare for release v1.17.0-pre.0
[ ] Allow the CI to sanity-check the PR (GitHub actions are enough) and get
review.
Note that it's likely that the "helm-charts" will fail since the GH
action regenerates the helm values file without understanding that
it's a release.
[ ] Revert the release commit and re-push
[x] Merge PR
[ ] Ping current top-hat that PRs can be merged again.
[ ] Create and push both tags to GitHub (v1.17.0-pre.0, 1.17.0-pre.0)
Pull latest branch locally.
Check out the commit before the revert and run ../release/internal/tag-release.sh
against that commit.
[x] Ask a maintainer to approve the build in the following link:
[Cilium Image Release builds]
[ ] Check if all docker images are available before announcing the release:
make -C install/kubernetes/ RELEASE=yes CILIUM_BRANCH=main check-docker-images
[ ] Run ../release/internal/post-release.sh URL to fetch the image
digests and submit draft release to the [releases] page. Use the URL
of the GitHub run here.
[x] Update helm charts
[ ] Create helm charts artifacts in [Cilium charts] repository using
[cilium helm release tool] for the v1.17.0-pre.0 release and push
these changes into the helm repository.
[ ] Check the output of the [chart workflow] and see if the test was
successful.
[ ] Check [read the docs] configuration:
[ ] Set a new build as active and hidden in [active versions].
[ ] Deactivate previous RCs.
[ ] Update algolia configuration search in [docsearch-scraper-webhook].
Update the versions in docsearch.config.json, commit them and push a trigger the workflow here
[ ] Check draft release from [releases] page
[ ] Update the text at the top with 2-3 highlights of the release
[ ] Mark the checkbox of "This is a pre-release"
[ ] Publish the release
[ ] Announce the release in #general on Slack.
Text template for the first RC:
This is the first monthly snapshot for the v1.17 development cycle. There are v1.17.0-pre.0 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.17.0-pre.0 OSS docs available if you want to pull this version & try it out.
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.17.0-pre.0 release process :ship:
../release/internal/start-release.sh v1.17.0-pre.0
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.AUTHORS
entries and verify if it is possible to get the real names instead of GitHub usernames.AUTHORS
as well as the documentation files changed by the previous step with titleupdate AUTHORS and Documentation
.CHANGELOG.md
file and commit all remaining changes with the titlePrepare for release v1.17.0-pre.0
../release/internal/submit-release.sh
)v1.17.0-pre.0
,1.17.0-pre.0
)../release/internal/tag-release.sh
against that commit.make -C install/kubernetes/ RELEASE=yes CILIUM_BRANCH=main check-docker-images
../release/internal/post-release.sh URL
to fetch the image digests and submit draft release to the [releases] page. Use theURL
of the GitHub run here.v1.17.0-pre.0
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.17.0-pre.0 has been released: https://github.com/cilium/cilium/releases/tag/v1.17.0-pre.0
This is the first monthly snapshot for the v1.17 development cycle. There are v1.17.0-pre.0 OSS docs available if you want to pull this version & try it out.
Announcement :tada: :tada:
:cilium-new: Cilium release candidate v1.17.0-pre.0 has been released: https://github.com/cilium/cilium/releases/tag/v1.17.0-pre.0
Thank you for the testing and contributing to the previous pre-releases. There are v1.17.0-pre.0 OSS docs available if you want to pull this version & try it out.