Skip to content

Commit

Permalink
Update the new release steps (kubernetes-sigs#3004)
Browse files Browse the repository at this point in the history
  • Loading branch information
mimowo authored and kannon92 committed Nov 19, 2024
1 parent 1e7f38d commit 519dd5e
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions .github/ISSUE_TEMPLATE/NEW_RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,38 +24,39 @@ Please do not remove items from the checklist
- [ ] Update `RELEASE_BRANCH` and `RELEASE_VERSION` in `Makefile` and run `make prepare-release-branch`
- [ ] Update the `CHANGELOG`
- [ ] Submit a pull request with the changes: <!-- example #211 #214 -->
- [ ] An OWNER [prepares a draft release](https://github.com/kubernetes-sigs/kueue/releases)
- [ ] Write the change log into the draft release.
- [ ] Run
`make artifacts IMAGE_REGISTRY=registry.k8s.io/kueue GIT_TAG=$VERSION`
to generate the artifacts and upload the files in the `artifacts` folder
to the draft release.
- [ ] 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](https://docs.github.com/en/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys).
- [ ] An OWNER pushes the tag with
`git push $VERSION`
`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`
- [ ] An OWNER [prepares a draft release](https://github.com/kubernetes-sigs/kueue/releases)
- [ ] 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 the `artifacts` folder.
- [ ] Upload the files in the `artifacts` folder to the draft release - either
via UI or `gh release upload <tag> artifacts/*`.
- [ ] Submit a PR against [k8s.io](https://github.com/kubernetes/k8s.io),
updating `registry.k8s.io/images/k8s-staging-kueue/images.yaml` to
[promote the container images](https://github.com/kubernetes/k8s.io/tree/main/k8s.gcr.io#image-promoter)
[promote the container images](https://github.com/kubernetes/k8s.io/tree/main/registry.k8s.io#image-promoter)
to production: <!-- example kubernetes/k8s.io#3612-->
- [ ] Wait for the PR to be merged and verify that the image `registry.k8s.io/kueue/kueue:$VERSION` is available.
- [ ] Publish the draft release prepared at the [GitHub releases page](https://github.com/kubernetes-sigs/kueue/releases).
Link: <!-- example https://github.com/kubernetes-sigs/kueue/releases/tag/v0.1.0 -->
- [ ] Run the [openvex action](https://github.com/kubernetes-sigs/kueue/actions/workflows/openvex.yaml) to generate openvex data. The action will add the file to the release artifacts.
- [ ] Update the `main` branch :
- [ ] Update `RELEASE_VERSION` in `Makefile` and run `make prepare-release-branch`
- [ ] Release notes in the `CHANGELOG`
- [ ] `SECURITY-INSIGHTS.yaml` values by running `make update-security-insights GIT_TAG=$VERSION`
- [ ] Submit a pull request with the changes: <!-- example #3007 -->
- [ ] Cherry-pick the pull request onto the `website` branch
- [ ] Run the [SBOM action](https://github.com/kubernetes-sigs/kueue/actions/workflows/sbom.yaml) to generate the SBOM and add it to the release.
- [ ] For major or minor releases, merge the `main` branch into the `website` branch to publish the updated documentation.
- [ ] Send an announcement email to `sig-scheduling@kubernetes.io` and `wg-batch@kubernetes.io` with the subject `[ANNOUNCE] kueue $VERSION is released`. <!--Link: example https://groups.google.com/a/kubernetes.io/g/wg-batch/c/-gZOrSnwDV4 -->
- [ ] Update the below files with respective values in `main` branch :
- Latest version in `README.md`
- Latest version in `cmd/experimental/kjobctl/docs/installation.md`
- Release notes in the `CHANGELOG`
- `version` in `site/hugo.toml`
- `appVersion` in `charts/kueue/Chart.yaml`
- `SECURITY-INSIGHTS.yaml` values by running `make update-security-insights GIT_TAG=$VERSION`
- [ ] For a major or minor release, prepare the repo for the next version:
- [ ] Create an unannotated _devel_ tag in the
`main` branch, on the first commit that gets merged after the release
Expand Down

0 comments on commit 519dd5e

Please sign in to comment.