Skip to content
This repository has been archived by the owner on Jun 13, 2020. It is now read-only.

Commit

Permalink
Update docs to describe new PR release-note block parsing.
Browse files Browse the repository at this point in the history
  • Loading branch information
david-mcmahon committed May 3, 2016
1 parent 9289907 commit 3118b0c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
9 changes: 6 additions & 3 deletions docs/devel/cherry-picks.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,12 @@ label changes to the **master** branch PR:
* 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.
1. `release-note` labeled PRs generate a release note using the PR title by
default OR the release-note block in the PR template if filled in.
* See the [PR template](../../.github/PULL_REQUEST_TEMPLATE.md) for more
details.
* PR titles and body comments are mutable and can be modified at any time
prior to the release to reflect a release note friendly message.

### How do cherrypick-candidates make it to the release branch?

Expand Down
10 changes: 7 additions & 3 deletions docs/devel/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,18 @@ The following will save time for both you and your reviewer:
## Release Notes

This section applies only to pull requests on the master branch.
For cherry-pick PRs, see the [Cherrypick instructions](cherry-picks.md)

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.
1. `release-note` labeled PRs generate a release note using the PR title by
default OR the release-note block in the PR template if filled in.
* See the [PR template](../../.github/PULL_REQUEST_TEMPLATE.md) for more
details.
* PR titles and body comments are mutable and can be modified at any time
prior to the release to reflect a release note friendly message.

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-*`
Expand Down

0 comments on commit 3118b0c

Please sign in to comment.