diff options
| author | Tim Pepper <tpepper@vmware.com> | 2019-03-19 13:52:26 -0700 |
|---|---|---|
| committer | Tim Pepper <tpepper@vmware.com> | 2019-03-19 13:52:26 -0700 |
| commit | d83cc3fda8be971d90b33d1d5c969426d4f8ee2e (patch) | |
| tree | 858dfaca1ed2063654d9bb9e0c0bc6dbe1b1be9e | |
| parent | 4b28da7913e28faa224aa5361d34ee68a2a61f59 (diff) | |
contributor docs: clarify cherry pick release notes
Cherry picks are now mostly handled primarily through automation,
including their release note block. In some cases that release
note automation may fail (multiple candidate release notes from
which to pick) and human intervention is required, but this amounts
to just adding the otherwise normal `release-note` block in the
pull request description.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
| -rw-r--r-- | contributors/devel/sig-release/cherry-picks.md | 7 | ||||
| -rw-r--r-- | contributors/guide/release-notes.md | 2 |
2 files changed, 8 insertions, 1 deletions
diff --git a/contributors/devel/sig-release/cherry-picks.md b/contributors/devel/sig-release/cherry-picks.md index 7769f970..097fef85 100644 --- a/contributors/devel/sig-release/cherry-picks.md +++ b/contributors/devel/sig-release/cherry-picks.md @@ -54,6 +54,13 @@ or the [Patch Release Team](https://git.k8s.io/sig-release/release-team/role-han are the final authority on removing the `do-not-merge/cherry-pick-not-approved` label and triggering a merge into the target branch. +Cherry-pick pull requests follow the same release note requirements as +other pull requests, except the release note stanza will auto-populate from +the master branch pull request from which the cherry-pick originated. If +this is unsuccessful the `do-not-merge/release-note-label-needed` label +will be applied and the cherry-pick author must edit the pull request +description to [add a release note](https://git.k8s.io/community/contributors/guide/release-notes.md). + ## Searching for Cherry-picks - [A sample search on kubernetes/kubernetes pull requests that are labeled as `cherry-pick-approved`](https://github.com/kubernetes/kubernetes/pulls?q=is%3Aopen+is%3Apr+label%3Acherry-pick-approved) diff --git a/contributors/guide/release-notes.md b/contributors/guide/release-notes.md index 81dca597..f0fe0784 100644 --- a/contributors/guide/release-notes.md +++ b/contributors/guide/release-notes.md @@ -30,4 +30,4 @@ For pull requests that don't need to be mentioned at release time, use the `/rel To see how to format your release notes, view the kubernetes/kubernetes [pull request template](https://git.k8s.io/kubernetes/.github/PULL_REQUEST_TEMPLATE.md) for a brief example. Pull Request titles and body comments can be modified at any time prior to the release to make them friendly for release notes. -Release notes apply to pull requests on the master branch. For cherry-pick pull requests, see the [cherry-pick instructions](/contributors/devel/sig-release/cherry-picks.md). The only exception to these rules is when a pull request is not a cherry-pick and is targeted directly to the non-master branch. In this case, a `release-note-*` label is required for that non-master pull request. +Release notes apply to pull requests on the master branch. For patch release branches the automated cherry-pick pull requests process (see the [cherry-pick instructions](/contributors/devel/sig-release/cherry-picks.md)) should be followed. That automation will pull release notes from the master branch PR from which the cherry-pick originated. On a rare occasion a pull request on a patch release branch is not a cherry-pick, but rather is targeted directly to the non-master branch and in this case, a `release-note-*` label is required for that non-master pull request. |