Welcome! We're glad you want to try out trop
.
trop
automates backporting PRs to versioned release branches.
- A
.github/config.yml
file. See this example.
Automatically With Labels:
- Open a bugfix or feature pull request to
master
- Add backport label(s) to the pull request (ex.
target/2-0-x
) - Your pull request is reviewed and you or a co-contributor merges it into
master
trop
will automatically open pull requests containingcherry-pick
s of the code into the backporting branches you specified in your labels (in this case,2-0-x
).- You or a co-contributor resolves any conflicts and merges in
trop
's backports
NOTE: If trop
fails to perform a backport, it will flag the original PR with needs-manual-backport/2-0-x
so that you or another contributor and perform the backport manually. Trop will keep track of manual backports
and update the labels appropriately.
Manual Triggering With Labels:
- Open a bugfix or feature pull request to
master
- Your pull request is reviewed and you or a co-contributor merges it into
master
- After it's been merged, you add backport label(s) to the pull request (ex.
target/2-0-x
) - You create a new comment with the following body:
/trop run backport
trop
will begin the backport process for target branches you have specified via labelstrop
will automatically open pull requests containingcherry-pick
s of the code into the backporting branches you specified in your labels (in this case,2-0-x
).- You or a co-contributor resolves any conflicts and merges in
trop
's backports
Manual Triggering Without Labels:
- Open a bugfix or feature pull request to
master
- Your pull request is reviewed and you or a co-contributor merges it into
master
- You create a new comment with the following body:
/trop run backport-to [BRANCH_NAME]
, where[BRANCH_NAME]
is replaced with the branch you wish to backport to trop
will begin the backport process for target branch you manually specifiedtrop
will automatically open pull requests containingcherry-pick
s of the code into the branch you specified in your comment body- You or a co-contributor resolves any conflicts and merges in the backport pull request
trop
created
Note
- You can delete the original PR branch whenever you want, trop does not need the original branch to perform the backport. Keep your repo's branchlist clean folks.
That's all there is to it! Congratulations, you did it! 🎉