Revise the "Backporting merged changes" guide#1819
Open
StanFromIreland wants to merge 1 commit into
Open
Conversation
Documentation build overview
5 files changed ·
|
| A pull request may need to be backported into one of the maintenance branches | ||
| after it has been accepted and merged into ``main``. It is usually indicated | ||
| by the label ``needs backport to X.Y`` on the pull request itself. | ||
| After a pull request has been merged into ``main``, it may need to be backported |
Member
There was a problem hiding this comment.
Do we have a section anywhere about deciding when to backport? If so, it would be good to link it here.
| Use the utility script | ||
| `cherry_picker.py <https://github.com/python/cherry-picker>`__ | ||
| to backport the commit. | ||
| ``miss-islington`` will automatically attempt to create backport PRs for the |
Member
There was a problem hiding this comment.
Suggested change
| ``miss-islington`` will automatically attempt to create backport PRs for the | |
| The Miss Islington bot will automatically attempt to create backport PRs for the |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I find the current instructions a little brief, so I propose expanding them a little more like so. Generally focusing on
cherry-picker, I don't think we also need to document the complete instructions for doing it withgithere. If this is merged, I plan to add a link to the section to the template failed-backport response, e.g.: