sigs.k8s.io/kueue@v0.6.2/.github/ISSUE_TEMPLATE/NEW_RELEASE.md (about)

     1  ---
     2  name: New Release
     3  about: Propose a new release
     4  title: Release v0.x.0
     5  assignees: ahg-g, alculquicondor, tenzen-y
     6  
     7  ---
     8  
     9  ## Release Checklist
    10  <!--
    11  Please do not remove items from the checklist
    12  -->
    13  - [ ] [OWNERS](https://github.com/kubernetes-sigs/kueue/blob/main/OWNERS) must LGTM the release proposal.
    14    At least two for minor or major releases. At least one for a patch release.
    15  - [ ] Verify that the changelog in this issue and the CHANGELOG folder is up-to-date
    16    - [ ] Use https://github.com/kubernetes/release/tree/master/cmd/release-notes to gather notes.
    17      Example: `release-notes --org kubernetes-sigs --repo kueue --branch release-0.3 --start-sha 4a0ebe7a3c5f2775cdf5fc7d60c23225660f8702 --end-sha a51cf138afe65677f5f5c97f8f8b1bc4887f73d2 --dependencies=false --required-author=""`
    18  - [ ] For major or minor releases (v$MAJ.$MIN.0), create a new release branch.
    19    - [ ] An OWNER creates a vanilla release branch with
    20          `git branch release-$MAJ.$MIN main`
    21    - [ ] An OWNER pushes the new release branch with
    22          `git push release-$MAJ.$MIN`
    23  - [ ] Update the release branch:
    24    - [ ] Update `RELEASE_BRANCH` and `RELEASE_VERSION` in `Makefile` and run `make prepare-release-branch`
    25    - [ ] Update the `CHANGELOG`
    26    - [ ] Submit a pull request with the changes: <!-- example #211 #214 -->
    27  - [ ] An OWNER [prepares a draft release](https://github.com/kubernetes-sigs/kueue/releases)
    28    - [ ] Write the change log into the draft release.
    29    - [ ] Run
    30        `make artifacts IMAGE_REGISTRY=registry.k8s.io/kueue GIT_TAG=$VERSION`
    31        to generate the artifacts and upload the files in the `artifacts` folder
    32        to the draft release.
    33  - [ ] An OWNER creates a signed tag running
    34       `git tag -s $VERSION`
    35        and inserts the changelog into the tag description.
    36        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).
    37  - [ ] An OWNER pushes the tag with
    38        `git push $VERSION`
    39    - Triggers prow to build and publish a staging container image
    40        `gcr.io/k8s-staging-kueue/kueue:$VERSION`
    41  - [ ] Submit a PR against [k8s.io](https://github.com/kubernetes/k8s.io),
    42        updating `registry.k8s.io/images/k8s-staging-kueue/images.yaml` to
    43        [promote the container images](https://github.com/kubernetes/k8s.io/tree/main/k8s.gcr.io#image-promoter)
    44        to production: <!-- example kubernetes/k8s.io#3612-->
    45  - [ ] Wait for the PR to be merged and verify that the image `registry.k8s.io/kueue/kueue:$VERSION` is available.
    46  - [ ] Publish the draft release prepared at the [Github releases page](https://github.com/kubernetes-sigs/kueue/releases).
    47        Link: <!-- example https://github.com/kubernetes-sigs/kueue/releases/tag/v0.1.0 -->
    48  - [ ] 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.
    49  - [ ] Run the [SBOM action](https://github.com/kubernetes-sigs/kueue/actions/workflows/sbom.yaml) to generate the SBOM and add it to the release.
    50  - [ ] For major or minor releases, merge the `main` branch into the `website` branch to publish the updated documentation.
    51  - [ ] 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 -->
    52  - [ ] Update the below files with respective values in `main` branch :
    53    - Latest version in `README.md`
    54    - Release notes in the `CHANGELOG`
    55    - `version` in `site/config.toml`
    56    - `appVersion` in `charts/kueue/Chart.yaml`
    57    - `last-updated`, `last-reviewed`, `commit-hash`, `project-release`, and `distribution-points` in `SECURITY-INSIGHTS.yaml`
    58  - [ ] For a major or minor release, prepare the repo for the next version:
    59    - [ ] create an unannotated _devel_ tag in the
    60          `main` branch, on the first commit that gets merged after the release
    61           branch has been created (presumably the README update commit above), and, push the tag:
    62          `DEVEL=v0.$(($MAJ+1)).0-devel; git tag $DEVEL main && git push $DEVEL`
    63          This ensures that the devel builds on the `main` branch will have a meaningful version number.
    64    - [ ] Create a milestone for the next minor release and update prow to set it automatically for new PRs:
    65          <!-- example https://github.com/kubernetes/test-infra/pull/30222 -->
    66  
    67  
    68  ## Changelog
    69  
    70  ```markdown
    71  Describe changes since the last release here.
    72  ```