| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 1 | # Gerrit Code Review |
| 2 | |
| 3 | [Gerrit](https://www.gerritcodereview.com) is a code review and project |
| 4 | management tool for Git based projects. |
| 5 | |
| Matthias Sohn | 00a3a71 | 2021-01-11 23:09:44 +0100 | [diff] [blame] | 6 | [](https://gerrit-ci.gerritforge.com/job/Gerrit-bazel-java11-master/) |
| Luca Milanesio | 0dd14b2 | 2020-06-04 20:50:50 +0100 | [diff] [blame] | 7 |  |
| Luca Milanesio | c0e2926 | 2016-10-15 23:49:45 +0100 | [diff] [blame] | 8 | |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 9 | ## Objective |
| 10 | |
| 11 | Gerrit makes reviews easier by showing changes in a side-by-side display, |
| 12 | and allowing inline comments to be added by any reviewer. |
| 13 | |
| 14 | Gerrit simplifies Git based project maintainership by permitting any |
| 15 | authorized user to submit changes to the master Git repository, rather |
| 16 | than requiring all approved changes to be merged in by hand by the project |
| 17 | maintainer. |
| 18 | |
| 19 | ## Documentation |
| 20 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 21 | For information about how to install and use Gerrit, refer to |
| 22 | [the documentation](https://gerrit-review.googlesource.com/Documentation/index.html). |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 23 | |
| 24 | ## Source |
| 25 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 26 | Our canonical Git repository is located on [googlesource.com](https://gerrit.googlesource.com/gerrit). |
| Luca Milanesio | fff21ac | 2017-04-05 09:01:58 +0100 | [diff] [blame] | 27 | There is a mirror of the repository on [Github](https://github.com/GerritCodeReview/gerrit). |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 28 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 29 | ## Reporting bugs |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 30 | |
| David Pursehouse | ff8982d | 2016-06-23 15:30:50 +0900 | [diff] [blame] | 31 | Please report bugs on the [issue tracker](https://bugs.chromium.org/p/gerrit/issues/list). |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 32 | |
| 33 | ## Contribute |
| 34 | |
| 35 | Gerrit is the work of hundreds of contributors. We appreciate your help! |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 36 | |
| 37 | Please read the [contribution guidelines](https://gerrit.googlesource.com/gerrit/+/master/SUBMITTING_PATCHES). |
| 38 | |
| 39 | Note that we do not accept Pull Requests via the Github mirror. |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 40 | |
| 41 | ## Getting in contact |
| 42 | |
| David Pursehouse | ec716e0 | 2015-06-30 08:22:26 +0000 | [diff] [blame] | 43 | The Developer Mailing list is [repo-discuss on Google Groups](https://groups.google.com/forum/#!forum/repo-discuss). |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 44 | |
| 45 | ## License |
| 46 | |
| 47 | Gerrit is provided under the Apache License 2.0. |
| 48 | |
| 49 | ## Build |
| 50 | |
| David Ostrovsky | fdbfcad | 2016-11-15 06:35:29 -0800 | [diff] [blame] | 51 | Install [Bazel](https://bazel.build/versions/master/docs/install.html) and run the following: |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 52 | |
| David Pursehouse | b964ac1 | 2018-10-12 14:01:39 +0900 | [diff] [blame] | 53 | git clone --recurse-submodules https://gerrit.googlesource.com/gerrit |
| David Ostrovsky | fdbfcad | 2016-11-15 06:35:29 -0800 | [diff] [blame] | 54 | cd gerrit && bazel build release |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 55 | |
| 56 | ## Install binary packages (Deb/Rpm) |
| 57 | |
| 58 | The instruction how to configure GerritForge/BinTray repositories is |
| Suriyaa Sundararuban | 045bd3a7 | 2018-06-15 10:26:41 +0000 | [diff] [blame] | 59 | [here](https://gitenterprise.me/2015/02/27/gerrit-2-10-rpm-and-debian-packages-available/) |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 60 | |
| 61 | On Debian/Ubuntu run: |
| 62 | |
| 63 | apt-get update & apt-get install gerrit=<version>-<release> |
| 64 | |
| 65 | _NOTE: release is a counter that starts with 1 and indicates the number of packages that have |
| 66 | been released with the same version of the software._ |
| 67 | |
| 68 | On CentOS/RedHat run: |
| 69 | |
| 70 | yum clean all && yum install gerrit-<version>[-<release>] |
| 71 | |
| Luca Milanesio | 1c16099 | 2016-10-27 08:27:54 +0100 | [diff] [blame] | 72 | On Fedora run: |
| 73 | |
| 74 | dnf clean all && dnf install gerrit-<version>[-<release>] |
| 75 | |
| 76 | ## Use pre-built Gerrit images on Docker |
| 77 | |
| 78 | Docker images of Gerrit are available on [DockerHub](https://hub.docker.com/u/gerritforge/) |
| 79 | |
| Luca Milanesio | cf8079b | 2020-06-04 20:56:02 +0100 | [diff] [blame] | 80 | To run a CentOS 8 based Gerrit image: |
| Luca Milanesio | 1c16099 | 2016-10-27 08:27:54 +0100 | [diff] [blame] | 81 | |
| Luca Milanesio | cf8079b | 2020-06-04 20:56:02 +0100 | [diff] [blame] | 82 | docker run -p 8080:8080 gerritcodereview/gerrit[:version]-centos8 |
| Luca Milanesio | 1c16099 | 2016-10-27 08:27:54 +0100 | [diff] [blame] | 83 | |
| Luca Milanesio | cf8079b | 2020-06-04 20:56:02 +0100 | [diff] [blame] | 84 | To run a Ubuntu 20.04 based Gerrit image: |
| Luca Milanesio | 1c16099 | 2016-10-27 08:27:54 +0100 | [diff] [blame] | 85 | |
| Luca Milanesio | cf8079b | 2020-06-04 20:56:02 +0100 | [diff] [blame] | 86 | docker run -p 8080:8080 gerritcodereview/gerrit[:version]-ubuntu20 |
| Luca Milanesio | 1c16099 | 2016-10-27 08:27:54 +0100 | [diff] [blame] | 87 | |
| David Ostrovsky | 0e5a1c3 | 2015-06-14 22:37:32 +0200 | [diff] [blame] | 88 | _NOTE: release is optional. Last released package of the version is installed if the release |
| 89 | number is omitted._ |
