From 69d6e4179021247e484edea5c99569f7ea9c98a6 Mon Sep 17 00:00:00 2001 From: Markus Lehtonen Date: Tue, 19 Sep 2023 14:40:23 +0300 Subject: [PATCH] github: add a separate issue template for patch releases Also simplify the wording on the major release issue template, eliminating "for a major release" from the text. --- .github/ISSUE_TEMPLATE/new-patch-release.md | 44 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/new-release.md | 9 ++--- 2 files changed, 48 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/new-patch-release.md diff --git a/.github/ISSUE_TEMPLATE/new-patch-release.md b/.github/ISSUE_TEMPLATE/new-patch-release.md new file mode 100644 index 000000000..f78fadd42 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-patch-release.md @@ -0,0 +1,44 @@ +--- +name: New Patch Release +about: Cut a new patch release +title: Release v0.x.y +assignees: adrianchiris, ArangoGutierrez, fmuyassarov, jjacobelli, kad, marquiz, PiotrProkop, zvonkok + +--- + +## Release Checklist + +- [ ] Verify that the changelog in this issue is up-to-date +- [ ] Run `hack/prepare-release.sh $VERSION` to turn references to point to the upcoming release + (README, deployment templates, docs configuration, test/e2e flags), submit a PR against the release branch +- An OWNER prepares a draft release + - [ ] Create a draft release at [Github releases page](https://github.com/kubernetes-sigs/node-feature-discovery/releases) + - [ ] Write the change log into the draft release + - [ ] Upload release artefacts generated by `prepare-release.sh` script above to the draft release +- [ ] An OWNER runs + `git tag -s $VERSION` + and inserts the changelog into the tag description. +- [ ] An OWNER pushes the tag with + `git push $VERSION` + - Triggers prow to build and publish a staging container image + `gcr.io/k8s-staging-nfd/node-feature-discovery:$VERSION` + - Triggers build of the documentation and publish it at + https://kubernetes-sigs.github.io/node-feature-discovery/0.$MAJ/ +- [ ] Submit a PR against [k8s.io](https://github.com/kubernetes/k8s.io), updating `registry.k8s.io/images/k8s-staging-nfd/images.yaml` to promote the container images (both "full" and "minimal" variants) to production +- [ ] Wait for the PR to be merged and verify that the image (`registry.k8s.io/nfd/node-feature-discovery:$VERSION`) is available. +- [ ] Publish the draft release prepared at the [Github releases page](https://github.com/kubernetes-sigs/node-feature-discovery/releases) + which will also trigger a Helm repo index update to add the latest release +- [ ] Add a link to the tagged release in this issue. +- [ ] For a point release of the latest newest release branch, update README in master branch + - [ ] Update references e.g. by running `hack/prepare-release.sh $VERSION` but **only** committing README.md, and, + submit a PR + - [ ] Wait for the PR to be merged +- [ ] Close this issue + + +## Changelog + diff --git a/.github/ISSUE_TEMPLATE/new-release.md b/.github/ISSUE_TEMPLATE/new-release.md index 5a9d47a80..e42d3b10e 100644 --- a/.github/ISSUE_TEMPLATE/new-release.md +++ b/.github/ISSUE_TEMPLATE/new-release.md @@ -12,7 +12,7 @@ Please do not remove items from the checklist --> - [ ] All [OWNERS](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/OWNERS) must LGTM the release proposal - [ ] Verify that the changelog in this issue is up-to-date -- [ ] For major releases (v0.$MAJ.0) create new release branch +- [ ] Create new release branch (release v0.$MAJ.0) - [ ] an OWNER creates a vanilla release branch with `git branch release-0.$MAJ master` - [ ] An OWNER pushes the new release branch with @@ -40,14 +40,13 @@ Please do not remove items from the checklist - [ ] Publish the draft release prepared at the [Github releases page](https://github.com/kubernetes-sigs/node-feature-discovery/releases) which will also trigger a Helm repo index update to add the latest release - [ ] Add a link to the tagged release in this issue. -- [ ] For a major release - - [ ] Send an announcement email to `dev@kubernetes.io` with the subject `[ANNOUNCE] node-feature-discovery $VERSION is released` +- [ ] Send an announcement email to `dev@kubernetes.io` with the subject `[ANNOUNCE] node-feature-discovery $VERSION is released` - [ ] Add a link to the release announcement in this issue -- [ ] For a major release (or a point release of the latest major release), update README in master branch +- [ ] Update README in master branch - [ ] Update references e.g. by running `hack/prepare-release.sh $VERSION` but **only** committing README.md, and, submit a PR - [ ] Wait for the PR to be merged -- [ ] For a major release, create an unannotated *devel* tag in the master branch, on the first commit that gets merged after the release branch has been created (presumably the README update commit above), and, push the tag: +- [ ] Create an unannotated *devel* tag in the master branch, 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=v0.$(($MAJ+1)).0-devel; git tag $DEVEL master && git push $DEVEL` This ensures that the devel builds on the master branch will have a meaningful version number. - [ ] Close this issue