red-hat-storage / downstream-cherry-picker

cherry-pick GitHub PRs that correspond to Red Hat Bugzilla bugs

downstream-cherry-picker

A tool to quickly cherry-pick whole GitHub pull requests that correspond to Red Hat Bugzilla bugs.

This is tool is suitable for cherry-picking upstream patches into downstream -patches branches for rdopkg to consume.

Example:

(Let's say you've cloned to ceph here):
$ cd dev/ceph

(And you have the "patches" remote set up like so):
$ git remote -v
  patches ssh://[e-mail]/ceph (fetch)
  patches ssh://[e-mail]/ceph (push)

(Update the remotes)
$ git remote update

(Reset your local branch to the latest "-patches"):
$ git checkout ceph-1.3-rhel-patches
$ git fetch patches
$ git reset --hard patches/ceph-1.3-rhel-patches

$ downstream-cherry-picker https://github.com/ceph/ceph/pull/10699 1335564
...

$ git log
(shows the new cherry-pick for that PR/bug.)

Installing:

The easiest way to get downstream-cherry-picker is use ktdreyer/downstream-cherry-picker copr on Fedora or el7:

dnf copr enable ktdreyer/downstream-cherry-picker

After you've enabled the repo, install the package:

dnf -y install downstream-cherry-picker

Or, if you want to hack on the code, install it in a Python virtualenv directly from GitHub:

virtualenv venv
. venv/bin/activate
git clone https://github.com/red-hat-storage/downstream-cherry-picker
cd downstream-cherry-picker
python setup.py develop

You will now have a downstream-cherry-picker utility in your $PATH.

Features:

• Uses GitHub's API to determine the range of commits to cherry-pick for a particular pull request.
• Cherry-picks each commit in a PR using standard conventions:
  • Adds "(cherry-picked from commit foo)" to each cherry-pick.
  • Adds "Resolves: rhbz#" to each cherry-pick.
• Does all the work on a separate "rhbz-" Git branch, so you can clean up if things go wrong or you have to resolve conflicts by hand. This branch name convention will trigger the Git commit hook that inserts the rhbz number into each changelog. If you do not have the Git commit hook installed into your repository, downstream-cherry-picker will download and install it for you.
• If everything cherry-picked cleanly, downstream-cherry-picker will merge the temporary rhbz- branch back into your original branch and delete the rhbz- branch, so that you're all ready to push your changes to the remote.
• Automatically fetches the pull request's commits if you don't have the commits in your local clone already.

Common Errors:

error: a cherry-pick or revert is already in progress

• This may have been a leftover from trying to cherry-pick previously. Abort the current cherry-pick, delete the old temp branch, and re-try:

  git chery-pick --abort
  git checkout ceph-2-rhel-patches
  git branch -D rhbz-1333809
  downstream-cherry-picker https://github.com/ceph/ceph/pull/13108 1333809