summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid McMahon <djmm@google.com>2016-04-06 13:20:03 -0700
committerDavid McMahon <djmm@google.com>2016-04-07 15:10:06 -0700
commita700866f4a8b33e3d339b086f066dc7fd51b574c (patch)
tree1d613f055836cb2e5fb284a8c776205dcad0aa84
parentb8eef418b486850a4351f739fdb6868e7501e33b (diff)
Sync up all release note related docs with the latest process/procedures.
-rw-r--r--cherry-picks.md5
-rw-r--r--pull-requests.md27
2 files changed, 28 insertions, 4 deletions
diff --git a/cherry-picks.md b/cherry-picks.md
index 02b5cc1e..3bc2a3ff 100644
--- a/cherry-picks.md
+++ b/cherry-picks.md
@@ -41,14 +41,15 @@ depending on the point in the release cycle.
## Propose a Cherry Pick
1. Cherrypicks are [managed with labels and milestones](pull-requests.md#release-notes)
-
1. All label/milestone accounting happens on PRs on master. There's nothing to do on PRs targeted to the release branches.
1. When you want a PR to be merged to the release branch, make the following label changes to the **master** branch PR:
-
* Remove release-note-label-needed
* Add an appropriate release-note-(!label-needed) label
* Add an appropriate milestone
* Add the `cherrypick-candidate` label
+ * The PR title is the **release note** you want published at release time and
+ note that PR titles are mutable and should reflect a release note
+ friendly message for any `release-note-*` labeled PRs.
### How do cherrypick-candidates make it to the release branch?
diff --git a/pull-requests.md b/pull-requests.md
index 6b68f716..5085651e 100644
--- a/pull-requests.md
+++ b/pull-requests.md
@@ -38,6 +38,7 @@ Documentation for other releases can be found at
- [Life of a Pull Request](#life-of-a-pull-request)
- [Before sending a pull request](#before-sending-a-pull-request)
- [Release Notes](#release-notes)
+ - [Reviewing pre-release notes](#reviewing-pre-release-notes)
- [Visual overview](#visual-overview)
- [Other notes](#other-notes)
- [Automation](#automation)
@@ -73,12 +74,34 @@ The following will save time for both you and your reviewer:
## Release Notes
-1. Your PR title is the **release note** you want published at release time.
-1. Release note labels are only needed on master branch PRs.
+This section applies only to pull requests on the master branch.
+
1. All pull requests are initiated with a `release-note-label-needed` label.
1. For a PR to be ready to merge, the `release-note-label-needed` label must be removed and one of the other `release-note-*` labels must be added.
1. `release-note-none` is a valid option if the PR does not need to be mentioned
at release time.
+1. The PR title is the **release note** you want published at release time.
+ * NOTE: PR titles are mutable and should reflect a release note friendly
+ message for any `release-note-*` labeled PRs.
+
+The only exception to these rules is when a PR is not a cherry-pick and is
+targeted directly to the non-master branch. In this case, a `release-note-*`
+label is optional (and not enforced).
+
+### Reviewing pre-release notes
+
+**NOTE: THIS TOOLING IS NOT YET AVAILABLE, BUT COMING SOON!**
+
+At any time, you can see what the release notes will look like on any branch.
+
+```
+$ git pull https://github.com/kubernetes/release
+$ RELNOTES=$PWD/release/relnotes
+$ cd /to/your/kubernetes/repo
+$ $RELNOTES -man # for details on how to use the tool
+# Show release notes from the last release on a branch to HEAD
+$ $RELNOTES --raw --branch=master
+```
## Visual overview