blob: da891ea6fcafe981535a64d53fe141e816780f5c [file] [log] [blame] [view]
David Ostrovsky0e5a1c32015-06-14 22:37:32 +02001# Gerrit Code Review
2
3[Gerrit](https://www.gerritcodereview.com) is a code review and project
4management tool for Git based projects.
5
Luca Milanesioc0e29262016-10-15 23:49:45 +01006[![Build Status](https://gerrit-ci.gerritforge.com/job/Gerrit-master/badge/icon)](https://gerrit-ci.gerritforge.com/job/Gerrit-master/)
7
David Ostrovsky0e5a1c32015-06-14 22:37:32 +02008## Objective
9
10Gerrit makes reviews easier by showing changes in a side-by-side display,
11and allowing inline comments to be added by any reviewer.
12
13Gerrit simplifies Git based project maintainership by permitting any
14authorized user to submit changes to the master Git repository, rather
15than requiring all approved changes to be merged in by hand by the project
16maintainer.
17
18## Documentation
19
David Pursehouseec716e02015-06-30 08:22:26 +000020For information about how to install and use Gerrit, refer to
21[the documentation](https://gerrit-review.googlesource.com/Documentation/index.html).
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020022
23## Source
24
David Pursehouseec716e02015-06-30 08:22:26 +000025Our canonical Git repository is located on [googlesource.com](https://gerrit.googlesource.com/gerrit).
Luca Milanesiofff21ac2017-04-05 09:01:58 +010026There is a mirror of the repository on [Github](https://github.com/GerritCodeReview/gerrit).
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020027
David Pursehouseec716e02015-06-30 08:22:26 +000028## Reporting bugs
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020029
David Pursehouseff8982d2016-06-23 15:30:50 +090030Please report bugs on the [issue tracker](https://bugs.chromium.org/p/gerrit/issues/list).
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020031
32## Contribute
33
34Gerrit is the work of hundreds of contributors. We appreciate your help!
David Pursehouseec716e02015-06-30 08:22:26 +000035
36Please read the [contribution guidelines](https://gerrit.googlesource.com/gerrit/+/master/SUBMITTING_PATCHES).
37
38Note that we do not accept Pull Requests via the Github mirror.
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020039
40## Getting in contact
41
David Pursehouseec716e02015-06-30 08:22:26 +000042The Developer Mailing list is [repo-discuss on Google Groups](https://groups.google.com/forum/#!forum/repo-discuss).
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020043
44## License
45
46Gerrit is provided under the Apache License 2.0.
47
48## Build
49
David Ostrovskyfdbfcad2016-11-15 06:35:29 -080050Install [Bazel](https://bazel.build/versions/master/docs/install.html) and run the following:
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020051
52 git clone --recursive https://gerrit.googlesource.com/gerrit
David Ostrovskyfdbfcad2016-11-15 06:35:29 -080053 cd gerrit && bazel build release
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020054
55## Install binary packages (Deb/Rpm)
56
57The instruction how to configure GerritForge/BinTray repositories is
58[here](http://gitenterprise.me/2015/02/27/gerrit-2-10-rpm-and-debian-packages-available)
59
60On Debian/Ubuntu run:
61
62 apt-get update & apt-get install gerrit=<version>-<release>
63
64_NOTE: release is a counter that starts with 1 and indicates the number of packages that have
65been released with the same version of the software._
66
67On CentOS/RedHat run:
68
69 yum clean all && yum install gerrit-<version>[-<release>]
70
Luca Milanesio1c160992016-10-27 08:27:54 +010071On Fedora run:
72
73 dnf clean all && dnf install gerrit-<version>[-<release>]
74
75## Use pre-built Gerrit images on Docker
76
77Docker images of Gerrit are available on [DockerHub](https://hub.docker.com/u/gerritforge/)
78
79To run a CentOS 7 based Gerrit image:
80
81 docker run -p 8080:8080 gerritforge/gerrit-centos7[:version]
82
83To run a Ubuntu 15.04 based Gerrit image:
84
85 docker run -p 8080:8080 gerritforge/gerrit-ubuntu15.04[:version]
86
David Ostrovsky0e5a1c32015-06-14 22:37:32 +020087_NOTE: release is optional. Last released package of the version is installed if the release
88number is omitted._