diff options
| author | Kubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com> | 2017-10-19 12:06:47 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-19 12:06:47 -0700 |
| commit | 9eff32599b4f270bb5260cf4e097f9417d6199a6 (patch) | |
| tree | e979bbe708ebbe6c78c5330b2aedb6376a9ef419 | |
| parent | 9d8f34af77d4446ce76045d977e81d703af51e00 (diff) | |
| parent | 5794eadad09d5a9fec84f67ec4dbd9c533d93509 (diff) | |
Merge pull request #1221 from xiangpengzhao/update-release-note
Automatic merge from submit-queue.
Update release note process
Update to latest process. Test in https://github.com/kubernetes/kubernetes/pull/53785
ref:
https://github.com/kubernetes/test-infra/pull/4718
https://github.com/kubernetes/kubernetes/pull/54114
/cc @cjwagner @Bradamant3
| -rw-r--r-- | contributors/devel/pull-requests.md | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/contributors/devel/pull-requests.md b/contributors/devel/pull-requests.md index 689912a6..40a7b28a 100644 --- a/contributors/devel/pull-requests.md +++ b/contributors/devel/pull-requests.md @@ -69,9 +69,7 @@ If your PR meets all of the steps above, it will enter the submit queue to be me Release notes are required for any PR with user-visible changes, such as bug-fixes, feature additions, and output format changes. -If you don't add release notes in the PR template the `do-not-merge/release-note-label-needed` label is added to your PR automatically when you create it. There are a few ways to update it. - -**Descriptions** +If you don't add release notes in the PR template, the `do-not-merge/release-note-label-needed` label is added to your PR automatically after you create it. There are a few ways to update it. To add a release-note section to the PR description: @@ -81,21 +79,24 @@ For PRs with a release note: Your release note here ``` -For PRs without a release note: +For PRs that require additional action from users switching to the new release, include the string "action required" (case insensitive) in the release note: + + ```release-note + action required: your release note here + ``` + +For PRs that don't need to be mentioned at release time, just write "NONE" (case insensitive): ```release-note NONE ``` +The `/release-note-none` comment command can still be used as an alternative to writing "NONE" in the release-note block if it is left empty. + To see how to format your release notes, view the [PR template](https://github.com/kubernetes/kubernetes/blob/master/.github/PULL_REQUEST_TEMPLATE.md) for a brief example. PR 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 PRs on the master branch. For cherry-pick PRs, see the [cherry-pick instructions](cherry-picks.md). 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 required for that non-master PR. -**Comments** - -- If the PR does not need to be mentioned at release time, leave the `/release-note-none` comment command. -- To create a release note, leave the `/release-note` comment command. This will generate a release note using the PR title by default OR the release-note block in the PR template, if it's filled in. - Now that your release notes are in shape, let's look at how the PR gets tested and merged. ## The Testing and Merge Workflow |