generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 451
Open
Description
Release Checklist
- OWNERS must LGTM the release proposal.
At least two for minor or major releases. At least one for a patch release. - Verify that the changelog in this issue and the CHANGELOG folder is up-to-date
- Use https://github.com/kubernetes/release/tree/master/cmd/release-notes to gather notes.
Example:release-notes --org kubernetes-sigs --repo kueue --branch release-0.3 --start-sha 4a0ebe7a3c5f2775cdf5fc7d60c23225660f8702 --end-sha a51cf138afe65677f5f5c97f8f8b1bc4887f73d2 --dependencies=false --required-author=""
- Use https://github.com/kubernetes/release/tree/master/cmd/release-notes to gather notes.
- For major or minor releases (v$MAJ.$MIN.0), create a new release branch.
- An OWNER creates a vanilla release branch with
git branch release-$MAJ.$MIN main - An OWNER pushes the new release branch with
git push upstream release-$MAJ.$MIN
- An OWNER creates a vanilla release branch with
- Update the release branch:
- Update
RELEASE_BRANCHandRELEASE_VERSIONinMakefileand runmake prepare-release-branch - Update the
CHANGELOG - Submit a pull request with the changes:
- Update
- An OWNER creates a signed tag running
git tag -s $VERSION
and inserts the changelog into the tag description.
To perform this step, you need a PGP key registered on github. - An OWNER pushes the tag with
git push upstream $VERSION- Triggers prow to build and publish a staging container image
us-central1-docker.pkg.dev/k8s-staging-images/kueue/kueue:$VERSION
- Triggers prow to build and publish a staging container image
- An OWNER prepares a draft release
- Create the draft release poiting out to the created tag.
- Write the change log into the draft release.
- Run
make artifacts IMAGE_REGISTRY=registry.k8s.io/kueue GIT_TAG=$VERSION
to generate the artifacts in theartifactsfolder. - Upload the files in the
artifactsfolder to the draft release - either
via UI orgh release --repo kubernetes-sigs/kueue upload $VERSION artifacts/*.
- Submit a PR against k8s.io to
promote the container images and Helm Chart
to production:- Update
registry.k8s.io/images/k8s-staging-kueue/images.yaml.
- Update
- Wait for the PR to be merged and verify that the image
registry.k8s.io/kueue/kueue:$VERSIONis available. - Publish the draft release prepared at the GitHub releases page.
Link: - Run the openvex action to generate openvex data. The action will add the file to the release artifacts.
- Run the SBOM action to generate the SBOM and add it to the release.
- Update the
mainbranch :- Update
RELEASE_VERSIONinMakefileand runmake prepare-release-branch - Release notes in the
CHANGELOG -
SECURITY-INSIGHTS.yamlvalues by runningmake update-security-insights GIT_TAG=$VERSION - Submit a pull request with the changes:
- Cherry-pick the pull request onto the
websitebranch
- Update
- For major or minor releases, merge the
mainbranch into thewebsitebranch to publish the updated documentation. - Send an announcement email to
sig-scheduling@kubernetes.ioandwg-batch@kubernetes.iowith the subject[ANNOUNCE] kueue $VERSION is released. - For a major or minor release, prepare the repo for the next version:
- Create an unannotated devel tag in the
mainbranch, on the first commit that gets merged after the release
branch has been created (presumably the README update commit above), and, push the tag:
DEVEL=v$MAJ.$(($MIN+1)).0-devel; git tag $DEVEL main && git push upstream $DEVEL
This ensures that the devel builds on themainbranch will have a meaningful version number. - Create a milestone for the next minor release and update prow to set it automatically for new PRs:
- Create the presubmits and the periodic jobs for the next patch release:
- Drop CI Jobs for testing the out-of-support branch:
- Create an unannotated devel tag in the
Changelog
Describe changes since the last release here.