Gerrit/git-review

git-review is a command-line tool for Git /  to submit a change or to fetch an existing one.

Note that Wikimedia Gerrit requires git-review version 1.27 or later.

The [https://docs.openstack.org/infra/git-review/ upstream project] is led by OpenStack. Is not to be confused with the unrelated [https://github.com/facebook/git-review Facebook project].

Installation

 *  See also: Gerrit tutorial 

After 1>Special:MyLanguage/Gerrit/Tutorial#Setting up Git|installing git (1, 2</>), creating a 2>wikitech:Help:Getting_Started#Create a User Account</>|gerrit user account, setting up an 3>Special:MyLanguage/Gerrit/Tutorial#Set Up SSH Keys in Gerrit</>|ssh key (<tvar|8>3</>, <tvar|9>4</>), and cloning a 4>Special:MyLanguage/Gerrit/Getting started</>|project repository (or 5>Special:MyLanguage/Gerrit/Tutorial#Download code using Git</>|example), you are ready to install git-review, a tool for working with Gerrit repositories so you don't have to remember some commands.

Follow the instructions below for your operating system, and don't forget to 1>Special:MyLanguage/Gerrit/Tutorial#Configuring git-review</>|configure it up afterwards!

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

Go to the appropriate section below

Having root access
You can do

or

If you do not have easy_install set up, try

If you don't have <tvar|1> </> but have <tvar|2> </> installed, you can use this; see far below for special OS X instructions.

If you have Ubuntu 20.04, 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 <tvar|1>commit-msg</> hook.

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

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

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.

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 <tvar|1> </> but must remember to use <tvar|2> </> instead.

Finally run:

or

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
If, while using git-review, you see <tvar|1> </>, you'll need to install <tvar|2> </>:

You may find that yum cannot find the <tvar|1>git-review</> package -- in this case you can [<tvar|2>https://support.rackspace.com/how-to/install-epel-and-additional-repositories-on-centos-and-red-hat/</> enable the EPEL repository] and try again.

OpenSUSE
Install (YaST) the <tvar|1> </>, then



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

Unstable
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
Install python and pip:

nix-env -i -A pythonPackages.pip

Add <tvar|1>~/.local/bin</> to your path:

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

Install git-review:

pip install git-review --user pip install --upgrade setuptools pip install --upgrade distribute

Install using pip Python package installer
Note: if you don't have <tvar|1> </> but have <tvar|2> </> installed, you can also install the latest version of git-review by using the 3>w:Pip (Python)</>|python package installer. The exact command depends on your distribution, either or

Once  is installed, you can

FreeBSD
You can directly install git-review through ports.

Windows
Python is needed for git-review to function and pip is used for its installation:
 * Install [<tvar|1>https://www.python.org/downloads/</> 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 <tvar|1></>), use the default, e.g. <tvar|2> </>
 * 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. <tvar|1> </>). 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 [<tvar|1>https://pip.pypa.io/en/latest/installing.html#install-or-upgrade-pip</> 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


 * If you experience problems such as these:
 * Retrying (Retry(total=4, connect=None, read=None, redirect=None)) after connection broken by 'ConnectTimeoutError(<pip._vendor.requests.packages.urllib3.connection.VerifiedHTTPSConnection object at 0x03B55750>, 'Connection to pypi.python.org timed out. (connect timeout=15)')': /simple/git-review/


 * try running:
 * pip install git-review --proxy=www-proxy-lon.uk.oracle.com:80


 * the exact proxy to use can be extracted from <tvar|1>http://wpad/wpad.dat</> file.


 * To use <tvar|1> </>, you have to be in a git clone directory that already contains a (possibly hidden) <tvar|2> </> configuration file (see 3>Special:MyLanguage/Gerrit/Advanced usage#Setting up a repository for git-remote</>|Setting up a repository for git-remote)

Method 1 (Homebrew)
Works on OS X 10.11 El Capitan and later (verified on High Sierra 10.13.5):


 * 1) Install Homebrew
 * 2) Install git-review with

Method 2 (Package Installer for Python “pip”)
Mac OS X comes with Python 2.7 (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):
 * 4) Update pip/setuptools (for OS X 10.7 and earlier only)
 * 5) Install git-review.  OS X as of version "El Capitan" protects locations in the filesystem including   so typical  install method will fail using sudo. Instead install git-review locally to your home folder like this:
 * 6) Update your PATH shell variable to include the location of git-review which should be in

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

If you get a  after a seemingly successful installation, do not reinstall over the existing installation, but uninstall git-review and redo

Setting up <tvar|1>git-review</>
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.

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 <tvar|1>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, it 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 topic of the original change
 * if your commit summary contains a bug number like, the topic will be
 * otherwise, the topic 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 alternative to copy-pasting 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.

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

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

Troubleshooting for Windows
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  to make git-review work properly:

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

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  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.