Gerrit/git-review

git-review is a command-line tool for Git / Gerrit. It makes it easier to configure your git clone, to submit a change or to fetch an existing one.

The upstream project is led by Openstack. Not to be confused with the unrelated Facebook project.

Installation

 * See also Gerrit/Tutorial.

After installing git, creating a gerrit user account, setting up an ssh key, and cloning a project repository (or example), you are ready to install git-review, a tool to simplify working with Gerrit repositories so you don't have to remember some pretty confusing commands.

Debian
Users of Debian or related distributions (e.g., Ubuntu, Mint) can do

Note:  Do not install git-review via apt. It looks like it works, but doesn't.

If you do not have easy_install set up, try

Then run:

in your cloned copy to setup to work with Gerrit. It will probably ask you for your commit username. Then it will automatically install the pre-commit hook.

Fedora/CentOS
You may find that yum cannot find the git-review package -- in this case you can enable the REMI repository and try again.

OpenSUSE
Install (YaST) the, then

Gentoo
Or use ebuild http://data.gpo.zugaina.org/openstack/dev-vcs/git-review/git-review-9999.ebuild

FreeBSD
You can directly install git-review through ports.

Windows

 * Install Python or upgrade to most current 2.7.x version.
 * Add your python scripts directory to the system path (e.g. C:\Python27\Scripts\). Different directories in path are delimited by a semicolon ";" only. Do not add any whitespace to path list.


 * Install python installer as follows, or see alternate instructions:
 * Download and run the setuptools installer for your versions of Windows and Python from here.
 * Download and run the pip installer for your versions of Windows and Python from here.


 * Run Git Bash as Administrator (right click on icon for this option).
 * Install git-review with the following command:
 * $ pip install git-review
 * Add the following line to a new text file and save it as git-review.bat in a PATH-accessible directory:
 * @python c:\Python27\Scripts\git-review %*

$ cd  $ cd 
 * Start Git Bash, go to the directory of you project repository clone using:
 * Set up git-review with:
 * $ git-review -s
 * This should install a git hook called  under  . Check that the file is there. From now on, commits will have a change-id appended to the summary, which Gerrit will need in order to accept any commits for review.
 * If this fails, you have a couple of options. The first is the use scp (secure copy) from within your local repository's directory, for each repository, before committing edits to it.
 * $ scp -P 29418 @gerrit.wikimedia.org:hooks/commit-msg .git/hooks/commit-msg
 * The second is to try patching "c:\Python27\Scripts\git-review" to make git-review work properly:


 * If using Python 2.x and git-review 1.17 or earlier, use "str.replace" instead of "unicode.replace".

Mac OS X
Mac OS X comes with Python (for now) but not the installation programs supported by git and git-review.


 * 1) Open Terminal and change to a directory you're comfortable downloading test Git packages to (such as Downloads or Sites)
 * 2) Download and install the OSX Installer for Git
 * 3) Install pip (Note: Already included in some older versions of Mac OS X):


 * 1) Install git-review:

Setting up git-review
To avoid confusion and conflicts between remotes named "gerrit" and "origin", the Gerrit tutorial recommends adding a git-review config file telling git review to use "origin" as its default remote.

After cloning a repository, you need to set up for using git-review. This will automatically happen the first time you try to submit a commit, but it's generally better to do it right after cloning.

This may ask you for your git username, if it's different from the shell username you're using.

Internally, this does the following:
 * checks whether accessing the remote repository works
 * if it doesn't, asks for a username and tries again
 * creates a remote called 'gerrit' that points to gerrit
 * installs the commit-msg hook

Submitting changes with git-review
Submitting changes with git review does not involve a lot of commands: $ git checkout -b mycoolfeature change files $ git commit -a $ git review

What happens when you submit a change
When you submit a change, git review does the following things:
 * it looks up which branch to push to (production or whatever) in the .gitreview file. If it can't find this information, if pushes to master
 * it figures out what "topic" to put on the revision (you can set the topic manually with )
 * if you're resubmitting a downloaded change, it will reuse the tag of the original change
 * if your commit summary contains a bug number like, the tag will be
 * otherwise, the tag will be the name of your local branch
 * it rebases your change against the HEAD of the branch you're pushing to (use  to skip this)
 * if you are submitting more than one change at once, or submitting a change that's based on another unmerged change, it will ask you whether you really meant to do that (use  to skip this)
 * it pushes the change for review

Downloading a change with git-review
When downloading a change from gerrit to review it or amend it, git-review offers an easier alternative to copypasting a magic incantation from the Gerrit web UI. All you need is the sequence number of the change in Gerrit, which you can find in the URL:. $ git review -d 2033 This will download the change, put it in a branch called  (if the change has no tag, the sequence number will be used instead), and switch to that branch.

Full feature branch workflow with git-review
you@yourmachine:~/puppet (production)$ git checkout -b mycoolfeature you@yourmachine:~/puppet (mycoolfeature)$ vi foobar you@yourmachine:~/puppet (mycoolfeature)$ git commit -a -m "Committing my cool feature" you@yourmachine:~/puppet (mycoolfeature)$ git review -f you@yourmachine:~/puppet (production)$ If the  flag is passed to git-review, it will try to submit the change, and if it succeeds it will switch back to the master branch (production in this case) and delete the feature branch.

Setting up a repository for git-remote
To tell git-remote where your repository is and what the name of the master branch is, you need to create a .gitremote file in the root of the repository, and commit it. The format is the following: The  and   fields are mandatory. The other fields are optional:  defaults to 29418 and   defaults to.

"Cannot query patchset information"
git-review does not work correctly if git generates non-English output. You will see an error like this:

$ git review -d 62474 Cannot query patchset information The following command failed with exit code 255 "ssh -x -p None gerrit query --format=JSON --current-patch-set change:62474" --- Bad port ' None' ---

This is due to a bug in git-review.

To work around this on a Linux system, either apply the patch from the bug report above, or set up an alias that forces git to use English output. To do so, put this into your  or similar setup file:

alias git="LANG=C git"

"Could not parse json query response: u'Verified'"
git-review version 1.18 has been reported to have issues when trying to review a change from Gerrit. You will see an error like this:

$ git review -d 76352 Could not parse json query response: u'Verified'

This seams to be due to a bug in git-review v1.18 since v1.12 and v1.21 work correct.

To work around this on a Linux system, use another version like v1.12 on fedora or v1.12, v1.21 on ubuntu (by downgrading or removing v1.18 and installing the suitable rpm). Version 1.22 under fedora works also.