msb-public
/
helm
mirror of https://github.com/helm/helm
1
0
Code Issues Projects Releases Wiki Activity

doc(release_checklist): Adds steps for categorizing changelogs

Browse Source 
Closes #5119

Also includes some formatting fixes to wrap lines at 80 chars

Signed-off-by: Taylor Thomas <taylor.thomas@microsoft.com>
pull/5122/head
Taylor Thomas 6 years ago
parent c82c0b6046
commit e3c6385959
1 changed files with 117 additions and 39 deletions
Show Stats Download Patch File Download Diff File

156
docs/release_checklist.md
Unescape View File

@ -3,8 +3,8 @@
**IMPORTANT**: If your experience deviates from this document, please document the changes to keep it up-to-date. **IMPORTANT**: If your experience deviates from this document, please document the changes to keep it up-to-date.
## Release Meetings ## Release Meetings
As part of the release process, two of the weekly developer calls will be co-opted As part of the release process, two of the weekly developer calls will be
as "release meetings." co-opted as "release meetings."
### Start of the Release Cycle ### Start of the Release Cycle
The first developer call after a release will be used as the release meeting to The first developer call after a release will be used as the release meeting to
@ -17,17 +17,19 @@ identified:
- Any other important details for the community - Any other important details for the community
All of this information should be added to the GitHub milestone for the given All of this information should be added to the GitHub milestone for the given
release. This should give the community and maintainers a clear set of guidelines release. This should give the community and maintainers a clear set of
to follow when choosing whether or not to add issues and PRs to a given release. guidelines to follow when choosing whether or not to add issues and PRs to a
given release.
### End (almost) of the Release Cycle ### End (almost) of the Release Cycle
The developer call closest to two weeks before the scheduled release date will The developer call closest to two weeks before the scheduled release date will
be used to review any remaining PRs that should be pulled into the release. This be used to review any remaining PRs that should be pulled into the release. This
is the place to debate whether or not we should wait before cutting a release and is the place to debate whether or not we should wait before cutting a release
any other concerns. At the end of this meeting, if the release date has not been and any other concerns. At the end of this meeting, if the release date has not
pushed out, the first RC should be cut. Subsequent developer calls in between this been pushed out, the first RC should be cut. Subsequent developer calls in
meeting and the release date should have some time set aside to see if any bugs between this meeting and the release date should have some time set aside to see
were found. Once the release date is reached, the final release can be cut if any bugs were found. Once the release date is reached, the final release can
be cut
## A Maintainer's Guide to Releasing Helm ## A Maintainer's Guide to Releasing Helm
@ -37,17 +39,28 @@ So you're in charge of a new release for Helm? Cool. Here's what to do...
Just kidding! :trollface: Just kidding! :trollface:
All releases will be of the form vX.Y.Z where X is the major version number, Y is the minor version number and Z is the patch release number. This project strictly follows [semantic versioning](http://semver.org/) so following this step is critical. All releases will be of the form vX.Y.Z where X is the major version number, Y
is the minor version number and Z is the patch release number. This project
strictly follows [semantic versioning](http://semver.org/) so following this
step is critical.
It is important to note that this document assumes that the git remote in your repository that corresponds to "https://github.com/helm/helm" is named "upstream". If yours is not (for example, if you've chosen to name it "origin" or something similar instead), be sure to adjust the listed snippets for your local environment accordingly. If you are not sure what your upstream remote is named, use a command like `git remote -v` to find out. It is important to note that this document assumes that the git remote in your
repository that corresponds to "https://github.com/helm/helm" is named
"upstream". If yours is not (for example, if you've chosen to name it "origin"
or something similar instead), be sure to adjust the listed snippets for your
local environment accordingly. If you are not sure what your upstream remote is
named, use a command like `git remote -v` to find out.
If you don't have an upstream remote, you can add one easily using something like: If you don't have an upstream remote, you can add one easily using something
like:
```shell ```shell
git remote add upstream git@github.com:helm/helm.git git remote add upstream git@github.com:helm/helm.git
``` ```
In this doc, we are going to reference a few environment variables as well, which you may want to set for convenience. For major/minor releases, use the following: In this doc, we are going to reference a few environment variables as well,
which you may want to set for convenience. For major/minor releases, use the
following:
```shell ```shell
export RELEASE_NAME=vX.Y.0 export RELEASE_NAME=vX.Y.0
@ -68,7 +81,10 @@ export RELEASE_CANDIDATE_NAME="$RELEASE_NAME-rc.1"
### Major/Minor Releases ### Major/Minor Releases
Major releases are for new feature additions and behavioral changes *that break backwards compatibility*. Minor releases are for new feature additions that do not break backwards compatibility. To create a major or minor release, start by creating a `release-vX.Y.0` branch from master. Major releases are for new feature additions and behavioral changes *that break
backwards compatibility*. Minor releases are for new feature additions that do
not break backwards compatibility. To create a major or minor release, start by
creating a `release-vX.Y.0` branch from master.
```shell ```shell
git fetch upstream git fetch upstream
@ -76,11 +92,13 @@ git checkout upstream/master
git checkout -b $RELEASE_BRANCH_NAME git checkout -b $RELEASE_BRANCH_NAME
``` ```
This new branch is going to be the base for the release, which we are going to iterate upon later. This new branch is going to be the base for the release, which we are going to
iterate upon later.
### Patch releases ### Patch releases
Patch releases are a few critical cherry-picked fixes to existing releases. Start by creating a `release-vX.Y.Z` branch from the latest patch release. Patch releases are a few critical cherry-picked fixes to existing releases.
Start by creating a `release-vX.Y.Z` branch from the latest patch release.
```shell ```shell
git fetch upstream --tags git fetch upstream --tags
@ -88,7 +106,8 @@ git checkout $PREVIOUS_PATCH_RELEASE
git checkout -b $RELEASE_BRANCH_NAME git checkout -b $RELEASE_BRANCH_NAME
``` ```
From here, we can cherry-pick the commits we want to bring into the patch release: From here, we can cherry-pick the commits we want to bring into the patch
release:
```shell ```shell
# get the commits ids we want to cherry-pick # get the commits ids we want to cherry-pick
@ -98,11 +117,13 @@ git cherry-pick -x <commit-id>
git cherry-pick -x <commit-id> git cherry-pick -x <commit-id>
``` ```
This new branch is going to be the base for the release, which we are going to iterate upon later. This new branch is going to be the base for the release, which we are going to
iterate upon later.
## 2. Change the Version Number in Git ## 2. Change the Version Number in Git
When doing a minor release, make sure to update pkg/version/version.go with the new release version. When doing a minor release, make sure to update pkg/version/version.go with the
new release version.
```shell ```shell
$ git diff pkg/version/version.go $ git diff pkg/version/version.go
@ -128,28 +149,36 @@ git commit -m "bump version to $RELEASE_CANDIDATE_NAME"
## 3. Commit and Push the Release Branch ## 3. Commit and Push the Release Branch
In order for others to start testing, we can now push the release branch upstream and start the test process. In order for others to start testing, we can now push the release branch
upstream and start the test process.
```shell ```shell
git push upstream $RELEASE_BRANCH_NAME git push upstream $RELEASE_BRANCH_NAME
``` ```
Make sure to check [helm on CircleCI](https://circleci.com/gh/helm/helm) and make sure the release passed CI before proceeding. Make sure to check [helm on CircleCI](https://circleci.com/gh/helm/helm) and
make sure the release passed CI before proceeding.
If anyone is available, let others peer-review the branch before continuing to ensure that all the proper changes have been made and all of the commits for the release are there. If anyone is available, let others peer-review the branch before continuing to
ensure that all the proper changes have been made and all of the commits for the
release are there.
## 4. Create a Release Candidate ## 4. Create a Release Candidate
Now that the release branch is out and ready, it is time to start creating and iterating on release candidates. Now that the release branch is out and ready, it is time to start creating and
iterating on release candidates.
```shell ```shell
git tag --sign --annotate "${RELEASE_CANDIDATE_NAME}" --message "Helm release ${RELEASE_CANDIDATE_NAME}" git tag --sign --annotate "${RELEASE_CANDIDATE_NAME}" --message "Helm release ${RELEASE_CANDIDATE_NAME}"
git push upstream $RELEASE_CANDIDATE_NAME git push upstream $RELEASE_CANDIDATE_NAME
``` ```
CircleCI will automatically create a tagged release image and client binary to test with. CircleCI will automatically create a tagged release image and client binary to
test with.
For testers, the process to start testing after CircleCI finishes building the artifacts involves the following steps to grab the client from Google Cloud Storage: For testers, the process to start testing after CircleCI finishes building the
artifacts involves the following steps to grab the client from Google Cloud
Storage:
linux/amd64, using /bin/bash: linux/amd64, using /bin/bash:
@ -169,21 +198,35 @@ windows/amd64, using PowerShell:
PS C:\> Invoke-WebRequest -Uri "https://kubernetes-helm.storage.googleapis.com/helm-$RELEASE_CANDIDATE_NAME-windows-amd64.zip" -OutFile "helm-$ReleaseCandidateName-windows-amd64.zip" PS C:\> Invoke-WebRequest -Uri "https://kubernetes-helm.storage.googleapis.com/helm-$RELEASE_CANDIDATE_NAME-windows-amd64.zip" -OutFile "helm-$ReleaseCandidateName-windows-amd64.zip"
``` ```
Then, unpack and move the binary to somewhere on your $PATH, or move it somewhere and add it to your $PATH (e.g. /usr/local/bin/helm for linux/macOS, C:\Program Files\helm\helm.exe for Windows). Then, unpack and move the binary to somewhere on your $PATH, or move it
somewhere and add it to your $PATH (e.g. /usr/local/bin/helm for linux/macOS,
C:\Program Files\helm\helm.exe for Windows).
## 5. Iterate on Successive Release Candidates ## 5. Iterate on Successive Release Candidates
Spend several days explicitly investing time and resources to try and break helm in every possible way, documenting any findings pertinent to the release. This time should be spent testing and finding ways in which the release might have caused various features or upgrade environments to have issues, not coding. During this time, the release is in code freeze, and any additional code changes will be pushed out to the next release. Spend several days explicitly investing time and resources to try and break helm
in every possible way, documenting any findings pertinent to the release. This
time should be spent testing and finding ways in which the release might have
caused various features or upgrade environments to have issues, not coding.
During this time, the release is in code freeze, and any additional code changes
will be pushed out to the next release.
During this phase, the $RELEASE_BRANCH_NAME branch will keep evolving as you will produce new release candidates. The frequency of new candidates is up to the release manager: use your best judgement taking into account the severity of reported issues, testers' availability, and the release deadline date. Generally speaking, it is better to let a release roll over the deadline than to ship a broken release. During this phase, the $RELEASE_BRANCH_NAME branch will keep evolving as you
will produce new release candidates. The frequency of new candidates is up to
the release manager: use your best judgement taking into account the severity of
reported issues, testers' availability, and the release deadline date. Generally
speaking, it is better to let a release roll over the deadline than to ship a
broken release.
Each time you'll want to produce a new release candidate, you will start by adding commits to the branch by cherry-picking from master: Each time you'll want to produce a new release candidate, you will start by
adding commits to the branch by cherry-picking from master:
```shell ```shell
git cherry-pick -x <commit_id> git cherry-pick -x <commit_id>
``` ```
You will also want to update the release version number and the CHANGELOG as we did in steps 2 and 3 as separate commits. You will also want to update the release version number and the CHANGELOG as we
did in steps 2 and 3 as separate commits.
After that, tag it and notify users of the new release candidate: After that, tag it and notify users of the new release candidate:
@ -197,7 +240,9 @@ From here on just repeat this process, continuously testing until you're happy w
## 6. Finalize the Release ## 6. Finalize the Release
When you're finally happy with the quality of a release candidate, you can move on and create the real thing. Double-check one last time to make sure everything is in order, then finally push the release tag. When you're finally happy with the quality of a release candidate, you can move
on and create the real thing. Double-check one last time to make sure everything
is in order, then finally push the release tag.
```shell ```shell
git checkout $RELEASE_BRANCH_NAME git checkout $RELEASE_BRANCH_NAME
@ -207,9 +252,13 @@ git push upstream $RELEASE_NAME
## 7. Write the Release Notes ## 7. Write the Release Notes
We will auto-generate a changelog based on the commits that occurred during a release cycle, but it is usually more beneficial to the end-user if the release notes are hand-written by a human being/marketing team/dog. We will auto-generate a changelog based on the commits that occurred during a
release cycle, but it is usually more beneficial to the end-user if the release
notes are hand-written by a human being/marketing team/dog.
If you're releasing a major/minor release, listing notable user-facing features is usually sufficient. For patch releases, do the same, but make note of the symptoms and who is affected. If you're releasing a major/minor release, listing notable user-facing features
is usually sufficient. For patch releases, do the same, but make note of the
symptoms and who is affected.
An example release note for a minor release would look like this: An example release note for a minor release would look like this:
@ -226,6 +275,13 @@ The community keeps growing, and we'd love to see you there!
- Hang out at the Public Developer Call: Thursday, 9:30 Pacific via [Zoom](https://zoom.us/j/696660622) - Hang out at the Public Developer Call: Thursday, 9:30 Pacific via [Zoom](https://zoom.us/j/696660622)
- Test, debug, and contribute charts: [GitHub/helm/charts](https://github.com/helm/charts) - Test, debug, and contribute charts: [GitHub/helm/charts](https://github.com/helm/charts)
## Features and Changes
- Major
- features
- list
- here
## Installation and Upgrading ## Installation and Upgrading
Download Helm X.Y. The common platform binaries are here: Download Helm X.Y. The common platform binaries are here:
@ -250,23 +306,45 @@ The [Quickstart Guide](https://docs.helm.sh/using_helm/#quickstart-guide) will g
## Changelog ## Changelog
- chore(*): bump version to v2.7.0 08c1144f5eb3e3b636d9775617287cc26e53dba4 (Adam Reese) ### Features
- ref(*): kubernetes v1.11 support efadbd88035654b2951f3958167afed014c46bc6 (Adam Reese)
- feat(helm): add $HELM_KEY_PASSPHRASE environment variable for signing helm charts (#4778) 1e26b5300b5166fabb90002535aacd2f9cc7d787
### Bug fixes
- fix circle not building tags f4f932fabd197f7e6d608c8672b33a483b4b76fa (Matthew Fisher) - fix circle not building tags f4f932fabd197f7e6d608c8672b33a483b4b76fa (Matthew Fisher)
### Code cleanup
- ref(kube): Gets rid of superfluous Sprintf call 3071a16f5eb3a2b646d9795617287cc26e53dba4 (Taylor Thomas)
- chore(*): bump version to v2.7.0 08c1144f5eb3e3b636d9775617287cc26e53dba4 (Adam Reese)
### Documentation Changes
- docs(release_checklist): fix changelog generation command (#4694) 8442851a5c566a01d9b4c69b368d64daa04f6a7f (Matthew Fisher)
``` ```
The changelog at the bottom of the release notes can be generated with this command: The changelog at the bottom of the release notes can be generated with this
command:
```shell ```shell
PREVIOUS_RELEASE=vX.Y.Z PREVIOUS_RELEASE=vX.Y.Z
git log --no-merges --pretty=format:'- %s %H (%aN)' $PREVIOUS_RELEASE..$RELEASE_NAME git log --no-merges --pretty=format:'- %s %H (%aN)' $PREVIOUS_RELEASE..$RELEASE_NAME
``` ```
Once finished, go into GitHub and edit the release notes for the tagged release with the notes written here. After generating the changelog, you will need to categorize the changes as shown
in the example above.
Once finished, go into GitHub and edit the release notes for the tagged release
with the notes written here.
## 8. Evangelize ## 8. Evangelize
Congratulations! You're done. Go grab yourself a $DRINK_OF_CHOICE. You've earned it. Congratulations! You're done. Go grab yourself a $DRINK_OF_CHOICE. You've earned
it.
After enjoying a nice $DRINK_OF_CHOICE, go forth and announce the glad tidings of the new release in Slack and on Twitter. You should also notify any key partners in the helm community such as the homebrew formula maintainers, the owners of incubator projects (e.g. ChartMuseum) and any other interested parties. After enjoying a nice $DRINK_OF_CHOICE, go forth and announce the glad tidings
of the new release in Slack and on Twitter. You should also notify any key
partners in the helm community such as the homebrew formula maintainers, the
owners of incubator projects (e.g. ChartMuseum) and any other interested
parties.
Optionally, write a blog post about the new release and showcase some of the new features on there! Optionally, write a blog post about the new release and showcase some of the new
features on there!

Write Preview
Loading…
Cancel
Save