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