-
Notifications
You must be signed in to change notification settings - Fork 0
Gerrit Workflow
This page describes the process for using Gerrit to submit changes to Xenon, initiate automated testing and perform code reviews.
Before you may begin, you'll need to have an account on the Gerrit server hosting Xenon builds:
- Visit https://review.ec.eng.vmware.com and click the Sign In link at the top-right corner of the page. Log in with your LDAP account (just username, no ‘@vmware.com’ required).
- Register your public SSH key by clicking on your name in the upper right-hand corner, go to Settings, SSH Public Keys or by following this link.
Ensure that you have told 'git' who you are as this will be required for access to Gerrit when using the 'git-review' plugin.
git config --global user.name "Firstname Lastname"
git config --global user.email "[email protected]"If you use multiple credentials for your projects, we presume you know how to switch (TODO: reference to using git with multiple logins)
Test your configuration now by issuing the following commands & make sure your username/email are correct.
git config --listWe recommend using the git-review tool which is a git subcommand that handles all the details of working with Gerrit, making this process much much easier. This component was developed by the folks at Openstack Infrastructure and used in the OpenStack code review system. It is widely available and included in the standard distros for Ubuntu, SUSE, Fedora and RHEL (see below). A nice documentation page for git-review is provided here. More information and documentation is available w/in the Openstack repository here.
Before you start work, make sure you have git-review installed on your system. Steps to perform for several platforms are provided below with more complete instructions available in the documentations links above.
On Ubuntu Precise (12.04) and later, git-review is included in the distribution, so install it as any other package:
apt-get install git-reviewOn Fedora 16 and later, git-review is included into the distribution, so install it as any other package
On Red Hat Enterprise Linux, you must first enable the EPEL repository, then install it as any other package:
yum install git-reviewOn openSUSE 12.2 and later, git-review is included in the distribution under the name python-git-review, so install it as any other package:
zypper in python-git-reviewOn Mac OS X, or most other Unix-like systems, you may install it with pip, or if you prefer the brew package manager:
pip install git-reviewFor more information on the brew package manager, please see the documentation. Installation instructions are provided at the brew home page.
brew install git-reviewYou can clone the repository in the usual way
git clone ssh://<username>@review.ec.eng.vmware.com:29418/xenonIf you;re having trouble, be sure that you have uploaded your public SSH key to Gerrit: https://review.ec.eng.vmware.com/#/settings/ssh-keys. Additionally, you may find it helpful to use an SSH config file
Host review.ec.eng.vmware.com
Hostname review.ec.eng.vmware.com
User <your gerrit username>
PreferredAuthentications publickey
IdentityFile <path/to/ssh_key.pubNext, you'll want git-review to configure your repository to know about Gerrit. If you don't, it will do so the first time you submit a review but you will need the git-hook installed beforehand which git-review can do for you
cd <xenon-project-directory>
git config --global gitreview.username yourgerritusername
git review -s
Git-review normally sets up the necessary git remotes and configurations for you. In the event that git review -s fails, it may be because git-review was unable to determine the location of your project. If that's the case, you can create the gerrit remote manually and re-run git-review
git remote add gerrit https://<username>@review.openstack.org/<umbrella repository name>/<repository name>.git
git review -s
Congratulations, you are now ready to submit changes for review on Xenon!
Move ahead to the Project Workflow discussion.