Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Make sure the backport tool is installed: go install

    1. For first time setup, you will need to set the cockroach.remote git config option. If Run git config cockroach.remote <myfork> where <myfork> is the remote in which your fork of cockroach is in the remote named origin, then set it with git config cockroach.remote origin while in your local cockroach git repo, e.g. origin.

  2. Run backport -r VV.V xxxxx, where VV.V is replaced by the version number of the release branch and xxxxx is replaced by the GitHub PR number of the PR you are trying to backport, or a space-separated list of PR numbers.
    This will automatically create a backport branch and upload it to your repository against the release branch to GitHub.
    Then, it will try to open your browser to create a new PR with that branch, or provide instruction on how to do this manually if it cannot open your browser.

    1. If there were merge conflicts, backport will halt and ask you to fix them. Once they're fixed, run backport --continue to continue the procedure.

    2. If there were any non-trivial merge conflicts, be sure to call those out in the PR message so reviewers can pay closer attention to the diff.

    3. If something goes wrong, you can use backport --abort to give up on the current manual backport.