mirror of
https://github.com/kubernetes-sigs/node-feature-discovery.git
synced 2024-12-15 17:50:49 +00:00
Replace RELEASE.md with an issue template
In addition to just moving the content, update release process. Adjust to the latest prow-based workflow. Capture steps required for documentation.
This commit is contained in:
parent
a08fb66fa7
commit
8ca38e26e3
2 changed files with 47 additions and 20 deletions
47
.github/ISSUE_TEMPLATE/new-release.md
vendored
Normal file
47
.github/ISSUE_TEMPLATE/new-release.md
vendored
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
---
|
||||||
|
name: New Release
|
||||||
|
about: Propose a new release
|
||||||
|
title: Release v0.x.0
|
||||||
|
assignees: ArangoGutierrez, Ethyling, kad, marquiz, zvonkok
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Release Checklist
|
||||||
|
<!--
|
||||||
|
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), an OWNER creates a release branch with
|
||||||
|
`git branch release-0.$MAJ master`
|
||||||
|
- [ ] Prepare `release-0.$MAJ` release branch
|
||||||
|
- [ ] Update the deployment templates to use the new tagged container image:
|
||||||
|
`sed s"|image: .*|image: k8s.gcr.io/nfd/node-feature-discovery:$VERSION|" -i *yaml.template`
|
||||||
|
- [ ] Update quick start instructions in README.md to use $VERSION
|
||||||
|
- [ ] Update version configuration in `docs/_config.yml`:
|
||||||
|
- set `version: $VERSION`
|
||||||
|
- add $VERSION to `versions:` list
|
||||||
|
- [ ] An OWNER runs
|
||||||
|
`git tag -s $VERSION`
|
||||||
|
and inserts the changelog into the tag description.
|
||||||
|
- [ ] An OWNER pushes the release branch with
|
||||||
|
`git push release-0.$MAJ`
|
||||||
|
This will trigger build of the documentation and publish it at https://kubernetes-sigs.github.io/node-feature-discovery/0.$MAJ/
|
||||||
|
- [ ] An OWNER pushes the tag with
|
||||||
|
`git push $VERSION`
|
||||||
|
This will trigger prow to build and publish a staging container image
|
||||||
|
`gcr.io/k8s-staging-nfd/node-feature-discovery:$VERSION`
|
||||||
|
- [ ] Submit a PR against [k8s.io](https://github.com/kubernetes/k8s.io), updating `k8s.gcr.io/images/k8s-staging-nfd/images.yaml` to promote the container image to production
|
||||||
|
- [ ] Wait for the PR to be merged and verify that the image (`k8s.gcr.io/nfd/node-feature-discovery:$VERSION`) is available.
|
||||||
|
- [ ] Write the change log into the [Github release info](https://github.com/kubernetes-sigs/node-feature-discovery/releases).
|
||||||
|
- [ ] Add a link to the tagged release in this issue.
|
||||||
|
- [ ] Update `index.html` in `gh-pages` branch to point to the latest release
|
||||||
|
- [ ] Send an announcement email to `kubernetes-dev@googlegroups.com` with the subject `[ANNOUNCE] node-feature-discovery $VERSION is released`
|
||||||
|
- [ ] Add a link to the release announcement in this issue
|
||||||
|
- [ ] Close this issue
|
||||||
|
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
<!--
|
||||||
|
Describe changes since the last release here.
|
||||||
|
-->
|
20
RELEASE.md
20
RELEASE.md
|
@ -1,20 +0,0 @@
|
||||||
# Release Process
|
|
||||||
|
|
||||||
The node-feature-discovery code is released on an as-needed basis. The process
|
|
||||||
is as follows:
|
|
||||||
|
|
||||||
1. An issue is filed to propose a new release with a changelog since the last
|
|
||||||
release. Copy the following checklist into the issue text:
|
|
||||||
|
|
||||||
- [ ] All [OWNERS](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/OWNERS) must LGTM the release proposal.
|
|
||||||
- [ ] Update the deployment templates ([master](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/nfd-master.yaml.template), [worker-daemonset](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/nfd-worker-daemonset.yaml.template), [worker-job](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/nfd-worker-job.yaml.template) and [combined](https://github.com/kubernetes-sigs/node-feature-discovery/blob/master/nfd-daemonset-combined.yaml.template))to use the new tagged container image
|
|
||||||
- [ ] An OWNER runs `git tag -s $VERSION` and insert the changelog into the tag description.
|
|
||||||
- [ ] An OWNER pushes the tag with `git push $VERSION` (this will also build and push a release container image to quay.io).
|
|
||||||
- [ ] An OWNER pulls the newly tagged image from quay.io, tags it with `gcr.io/k8s-staging-nfd/node-feature-discovery:$VERSION` and pushes it to `gcr.io/k8s-staging-nfd`
|
|
||||||
- [ ] Create a PR against [k8s.io](https://github.com/kubernetes/k8s.io), updading `k8s.gcr.io/images/k8s-staging-nfd/images.yaml` to promote the release image into production.
|
|
||||||
- [ ] Wait for the PR to be merged and verify that the image (`k8s.gcr.io/nfd/node-feature-discovery:$VERSION`) is available.
|
|
||||||
- [ ] Write the change log into the [Github release info](https://github.com/kubernetes-sigs/node-feature-discovery/releases).
|
|
||||||
- [ ] Add a link to the tagged release in this issue.
|
|
||||||
- [ ] An announcement email is sent to `kubernetes-dev@googlegroups.com` with the
|
|
||||||
subject `[ANNOUNCE] node-feature-discovery $VERSION is released`. Add a link to the release announcement here.
|
|
||||||
- [ ] Close this issue.
|
|
Loading…
Reference in a new issue