Docs: add guidelines for patch release communication (fixes #7277) #8823
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This updates the release documentation to describe how to use release issues to communicate releases to the team.
not-an-aardvark
added
accepted
|
LGTM |
docs/maintainer-guide/releases.md
Outdated
| 1. Make release announcement on Twitter. | ||
| 1. Remind the team not to merge anything other than documentation changes and bug fixes. | ||
| 1. Update the release blog post with a "Highlights" section, including new rules and anything else that's important. | ||
| 1. Make a release announcement in the chatroom. |
There was a problem hiding this comment.
Since you're doing a clarity pass, should we say "public chatroom" to be very clear here? Probably not necessary but something to consider.
docs/maintainer-guide/releases.md
Outdated
| After the patch release has been published (or no patch release is necessary), inform the team that they can start merging in changes again. | ||
| In rare cases, a second patch release might be necessary if the release is known to have a severe regression that hasn't been fixed by Monday. If this occurs, the release team should announce the situation on the release issue, and leave the issue open until all patch releases are complete. However, it's usually better to fix bugs for the next release cycle rather than doing a second patch release. | ||
|
|
||
| After the patch release has been published (or no patch release is necessary), close the release issue and inform the team that they can start merging in changes again. |
There was a problem hiding this comment.
s/merging in changes/merging in semver-minor changes?
|
LGTM |
This was referenced Jul 9, 2017
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request? (put an "X" next to item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
This updates the release documentation to describe how to use release issues to communicate releases to the team.
Is there anything you'd like reviewers to focus on?
Is there anything important I missed?