Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.56 KB

usage.md

File metadata and controls

46 lines (34 loc) · 2.56 KB
Raw

Setting Up trop

Welcome! We're glad you want to try out trop.

What Does trop Do?

trop automates backporting PRs to versioned release branches.

You Will Need:

  1. A .github/config.yml file. See this example.

Using trop:

Automatically With Labels:

  1. Open a bugfix or feature pull request to master
  2. Add backport label(s) to the pull request (ex. target/2-0-x)
  3. Your pull request is reviewed and you or a co-contributor merges it into master
  4. trop will automatically open pull requests containing cherry-picks of the code into the backporting branches you specified in your labels (in this case, 2-0-x).
  5. 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:

  1. Open a bugfix or feature pull request to master
  2. Your pull request is reviewed and you or a co-contributor merges it into master
  3. After it's been merged, you add backport label(s) to the pull request (ex. target/2-0-x)
  4. You create a new comment with the following body: /trop run backport
  5. trop will begin the backport process for target branches you have specified via labels
  6. trop will automatically open pull requests containing cherry-picks of the code into the backporting branches you specified in your labels (in this case, 2-0-x).
  7. You or a co-contributor resolves any conflicts and merges in trop's backports

Manual Triggering Without Labels:

  1. Open a bugfix or feature pull request to master
  2. Your pull request is reviewed and you or a co-contributor merges it into master
  3. 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
  4. trop will begin the backport process for target branch you manually specified
  5. trop will automatically open pull requests containing cherry-picks of the code into the branch you specified in your comment body
  6. 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! 🎉