Gerrit/git-review

From MediaWiki.org
Jump to: navigation, search

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. Is not to be confused with the unrelated Facebook project.

Installation[edit]

See also Gerrit/Tutorial#Installing git-review.

Linux[edit]

Debian/Ubuntu/Mint[edit]

Users of Debian or related distributions (e.g., Ubuntu, Mint) on a shared host usually do not have root access. If you cannot get you hosting administrator to install git-review for you, you can try to install it locally. Go to the appropriate section below

Having root access[edit]

You can do

 sudo apt-get install git-review

or

 sudo apt-get install python-pip
 sudo easy_install pip
 sudo pip install git-review==1.21

If you do not have easy_install set up, try

 sudo apt-get install python-setuptools

If you don't have apt-get but have python installed (e.g. on OS X), you can use this:

$ sudo easy_install pip
$ sudo pip install git-review==1.21

Then run:

 git review -s

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 commit-msg hook.

Without root access[edit]

If you are on a shared host and your system does not have git-review, you can install it locally in your user directory.

virtualenv --python=/usr/bin/python2.6 virtualenv
virtualenv/bin/pip install git-review==1.21

If this is your first local install, or you have not done that already, extend your PATH to include the the local binaries. There are two ways to do that. The more convervative way

PATH=$PATH:~/virtualenv/bin/

lets the system look through all binary directories first, and only looks into the local binary directory if a command was not found elsewhere. If you want software installed locally in your home directory to override system programs, you need the inverse the sort order.

PATH=~/virtualenv/bin/:$PATH

You probably did that earlier already. You may want to add either command to your login sequence to have it run automatically.

If you do not want to alter your PATH variable, you don't have to. In this case, you cannot use the command git review but must remember to use ~/virtualenv/bin/git-review instead.

Finally run:

 git review -s

or

 ~/virtualenv/bin/git-review -s

respectively, in your cloned copy to set it up to work with Gerrit. It will probably ask you for your commit username. Then it will automatically install the commit-msg hook.

Fedora≤21/CentOS[edit]

 sudo yum install git-review

If, while using git-review, you see ImportError: No module named requests, you'll need to install python-requests:

 sudo yum install python-requests

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

Fedora≥22[edit]

 sudo dnf install git-review

OpenSUSE[edit]

Install (YaST) the python-setuptools, then

 easy_install pip
 pip install git-review==1.21

Pip easy install.png

As of OpenSUSE 13.1, git-review is included in the main repository, so you can use

sudo zypper in git-review

Gentoo[edit]

 emerge dev-python/pip
 pip install git-review==1.21

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

Arch Linux[edit]

sudo pacman -S git-review

NixOS[edit]

Unstable[edit]

If you are running the unstable branch of nixpkgs, git-review is available as a package. Install with:

$ nix-env -i python2.7-git-review
Older branches of nixpkgs[edit]

Install python and pip:

$ nix-env -i -A pythonPackages.pip

Add ~/.local/bin to your path:

$ export PATH=$PATH:~/.local/bin
$ echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc

Install git-review:

$ pip install git-review==1.21 --user
$ pip install --upgrade setuptools
$ pip install --upgrade distribute

Install using pip Python package installer[edit]

Note: if you don't have apt-get but have python installed, you can also install the latest version of git-review by using the python package installer. The exact command depends on your distribution, either

$ sudo apt-get install python-pip

or

$ sudo easy_install pip

Apt-get install python-pip.png

Once pip is installed, you can

$ sudo pip install git-review

Pip install git-review.png

FreeBSD[edit]

You can directly install git-review through ports.

 cd /usr/ports/devel/git-review
 make install

Windows[edit]

Python is needed for git-review to function and pip is used for its installation:

  • Install Python or upgrade to the most current version of Python 2 or Python 3.
  • Important: Do not install Python in any directory with a space in its path as there is a pip bug (see [1]), use the default, e.g. C:\Python34\
  • During the Python installation, manually select Add python.exe to Path
  • Otherwise, add your python scripts directory manually to the system path (Settings, Control panel, System, Advanced system settings, Environment variables, User variables, Path; e.g. C:\Python34\;C:\Python34\Scripts\;). Different directories in path are delimited by a semicolon ";" only - do not add any whitespace to path list.)
  • Python 3.4 has pip already installed. Only if you have an older version, install pip by following the instructions here.
  • Run Git Bash as Administrator (right click on icon for this option) and install git-review with the following command:
$ pip install git-review
  • To use git review, you have to be in a git clone directory that already contains a (possibly hidden) .gitreview configuration file (see Gerrit/Advanced usage#Setting up a repository for git-remote), otherwise you will get the error message UnboundLocalError: local variable 'no_git_dir' referenced before assignment

Mac OS X[edit]

Method 1[edit]

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)
  2. Download and install the OS X Installer for Git (for OS X 10.8 and earlier only, OS X 10.9 ships with Git pre-installed)
  3. Install pip (Note: Already included in some older versions of OS X):
    sudo easy_install pip
    
  4. Update pip/setuptools (for OS X 10.7 and earlier only)
    sudo pip install -U setuptools
    
  5. Install git-review:
    sudo pip install git-review
    

If you get the error pkg_resources.DistributionNotFound: git-review, you may want to try nuking the pre-installed Python (/Library/Python/), installing Python via homebrew (brew install python), and re-installing setuptools and git-review.

If you get a git command not found after a seemingly successful installation, do not reinstall over the existing installation, but uninstall git-review and redo sudo pip install -U setuptools

Method 2[edit]

Works on OS X 10.11 El Capitan:

  1. Install Homebrew
  2. Install git-review with brew install git-review

Setting up git-review[edit]

Follow the instructions in the Gerrit tutorial to configure git-review so that it uses "origin" as its default remote. This avoids confusion and conflicts between remotes named "gerrit" and "origin".

After cloning a repository, you need to set it 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.

 $ cd MyNewProj
 $ git review -s

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

Troubleshooting for Windows[edit]

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 USERNAME@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:

--- /c/Python27/Scripts/git-review-old  Tue May 28 20:51:50 2013
+++ /c/Python27/Scripts/git-review      Tue May 28 20:48:03 2013
@@ -952,6 +952,9 @@
     config = get_config(os.path.join(top_dir, ".gitreview"))
     hook_file = os.path.join(git_dir, "hooks", "commit-msg")

+    # msysgit hacks to work around scp.exe (--aaron)
+    hook_file = unicode.replace( ".\%s" % os.path.relpath( hook_file ), "\\", "/" )
+
     defaultrebase = convert_bool(
         git_config_get_value("gitreview", "rebase",
                              default=str(config['defaultrebase'])))

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

Another error encountered on Windows is:

    ...
    (top_dir, git_dir) = git_directories()
ValueError: too many values to unpack (expected 2)

One solution to this is to change the return line of git_directories() to use splitlines rather than its normal split function. Split looks for any whitespace and will produce this error when the path to your source code directory contains a space. Splitlines looks for newline characters and will not produce this same error.

     return out.splitlines()

Submitting changes with git-review[edit]

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[edit]

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, it pushes to master
  • it figures out what "topic" to put on the revision (you can set the topic manually with -t)
    • 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 bug 12345, the tag will be bug/12345
    • 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 -R 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 -y to skip this)
  • it pushes the change for review

Downloading a change with git-review[edit]

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: https://gerrit.wikimedia.org/r/#/c/2033.

$ git review -d 2033

This will download the change, put it in a branch called review/AUTHOR/TAG (if the change has no tag, the sequence number will be used instead), and switch to that branch.

After that, you can amend the downloaded change to improve it.

Troubleshooting[edit]

For problems and how to solve them, see Gerrit/Troubleshooting.

See also[edit]