-
Notifications
You must be signed in to change notification settings - Fork 38.7k
doc: Add a note about backporting #17159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
@laanwj So what do you think about adding this note to the documentation? |
|
I think it is a good idea to add information about backporting (when to backport, how to backport) to the documentation, but I'm not sure a disconnected note only saying what not to do is the best way. |
|
In this case we could see that the backport was clearly requested, so "when to backport" was easy. "How to backport" was as you commented an automated conflict-free cherry-pick. Which leads me to following idea of text: Backporting is done whenever the fix needs to be present in a release branch (e.g. a security issue) or on request. If the backport is trivial and can be cherry-picked automatically, just request a "Needs backport" tag for the original issue or PR. If backport needs any conflict resolution, create the PR manually and wait for comments. The commit message of a backport should additionally contain following two lines in the end: What do you think @laanwj ? I am not force-pushing yet and ready to close this PR if needed. Edit: "add" [a tag] "to" → "request" [a tag] "for" |
|
Looks good to me, thanks! Another thing to mention maybe is to only create a backport PR (when necessary) after the original PR was merged into master. This makes sure that the latest version of the code is backported, so makes review easier (no moving target). |
0d0afbe to
2d16914
Compare
hebasto
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concept ACK 2d169144049da82d2db81efc872cb2e2b6eddea5.
Also backport.py script could be mentioned.
promag
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concept ACK. Could link to an example PR?
@hebasto please have a look at 28537b729 and tell me what you think Edit: I actually removed the redundant header, see e52ac9c36 |
9e10267 to
cb0a440
Compare
|
I mean adding an example, like #16189. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd re-write the text to be something like:
Security and bug fixes can be backported from master to release branches.
If the backport is non-trivial, it may be appropriate to open an additional PR,
to backport the change, only after the original PR has been merged.
Otherwise, backports will be done in batches by maintainers.
A backport should contain the following metadata in the commit body:
Github-Pull ...
Also, this PR does not need backporting.
03020ea to
b69a091
Compare
@fanquake Text changed. Have a look. |
77ef72c to
fff6163
Compare
fff6163 to
4d47775
Compare
|
This looks ok now. @carnhofdaki can you squash. |
|
@fanquake Sure. Thank you for info. |
See laanwj's comment in bitcoin#17158 bitcoin#17158 (comment) Co-Authored-By: Wladimir J. van der Laan <[email protected]> Co-Authored-By: Hennadii Stepanov <[email protected]> Co-Authored-By: João Barbosa <[email protected]> Co-Authored-By: Michael <[email protected]> Co-Authored-By: Luke Dashjr <[email protected]>
9e35eae to
2a6bce4
Compare
2a6bce4 doc: Add a note about backporting (Carnhof Daki) Pull request description: See laanwj's comment in bitcoin#17158 bitcoin#17158 (comment) Top commit has no ACKs. Tree-SHA512: ac5248a796050ce1a5bd0718955f941f6a3c025e192599948f12566eb55296079404b999676b9a2c8fe10616fc8334698dfa415af0fb4db6c98038d52218af1f
2a6bce4 doc: Add a note about backporting (Carnhof Daki) Pull request description: See laanwj's comment in bitcoin#17158 bitcoin#17158 (comment) Top commit has no ACKs. Tree-SHA512: ac5248a796050ce1a5bd0718955f941f6a3c025e192599948f12566eb55296079404b999676b9a2c8fe10616fc8334698dfa415af0fb4db6c98038d52218af1f
2a6bce4 doc: Add a note about backporting (Carnhof Daki) Pull request description: See laanwj's comment in bitcoin#17158 bitcoin#17158 (comment) Top commit has no ACKs. Tree-SHA512: ac5248a796050ce1a5bd0718955f941f6a3c025e192599948f12566eb55296079404b999676b9a2c8fe10616fc8334698dfa415af0fb4db6c98038d52218af1f
2a6bce4 doc: Add a note about backporting (Carnhof Daki) Pull request description: See laanwj's comment in bitcoin#17158 bitcoin#17158 (comment) Top commit has no ACKs. Tree-SHA512: ac5248a796050ce1a5bd0718955f941f6a3c025e192599948f12566eb55296079404b999676b9a2c8fe10616fc8334698dfa415af0fb4db6c98038d52218af1f
See laanwj's comment in #17158
#17158 (comment)