RETIRED, Gerrit as used by OpenStack
Go to file
Edwin Kempin cd07df425d Allow to explicitly specify whom to notify on a change update
When pushing changes/patch sets and when making change updates through
the REST API callers can specify a 'notify' option to control who
should be notified (not all REST endpoints support this option). This
'notify' option allows to choose if owner, reviewers, watchers and
users that have starred the change should be notified, or if no
notification should be send. For some tools this is not sufficient as
they want to have full control over which users should be notified.
E.g. if a CI integration is triggered by a certain label, the owner
and the user that triggered the CI should be notified.

To support this the REST API input entities that support the 'notify'
option are extended by a 'notify_details' options that allows the
caller to specify accounts that should be notified. These accounts are
always notified, even if notifications are otherwise disabled by
setting 'notify' to 'NONE'.

The 'notify_details' option is a map that maps a recipient type to a
'NotifyInfo' entity. This means callers can control how the accounts
should be notified, as TO, CC or BCC. The 'NotifyInfo' entity hosts
the list of accounts that should be notified. It is an extra entity so
that further entities that should be notified can be added in future.
E.g. one could imagine to add a list of emails (for user without
Gerrit account), a list of groups or a list of star labels (notify all
users that have set this star label on the change).

Also when pushing commits for review, specific accounts can be
explicitly notified by setting 'notify-to=<email>',
'notify-cc=<email>' or 'notify-bcc=<email>' in the push specification:

  git push origin HEAD:refs/for/master%notify-to=foo@bar.com

These accounts are not added as reviewer or CC so that they are not
signed up to receive notifications for futher updates of the change.

Change-Id: Id112b70158b80f84f631b5022f33228871716108
Signed-off-by: Edwin Kempin <ekempin@google.com>
2016-12-05 15:03:11 +01:00
.settings Build with Java 8 2016-09-20 10:19:52 +02:00
bucklets Buck: Fix typo in gerrit_plugin.bucklet 2015-12-23 17:55:11 +01:00
contrib Remove unused/outdated Pylint configuration file 2016-10-20 09:07:01 +09:00
Documentation Allow to explicitly specify whom to notify on a change update 2016-12-05 15:03:11 +01:00
gerrit-acceptance-framework Allow to explicitly specify whom to notify on a change update 2016-12-05 15:03:11 +01:00
gerrit-acceptance-tests Allow to explicitly specify whom to notify on a change update 2016-12-05 15:03:11 +01:00
gerrit-antlr bazel: remove 'out' attribute from genrule2, and use throughout. 2016-11-02 13:54:10 +01:00
gerrit-cache-h2 Support for setting diskLimit from CacheModule bindings 2016-09-22 22:51:33 +02:00
gerrit-common Merge "Support negative-only labels" 2016-11-25 13:08:18 +00:00
gerrit-elasticsearch Merge changes from topic 'reindex-if-stale' 2016-11-29 12:05:52 +00:00
gerrit-extension-api Allow to explicitly specify whom to notify on a change update 2016-12-05 15:03:11 +01:00
gerrit-gpg bazel: mark test only libraries as such. 2016-11-08 12:53:17 +01:00
gerrit-gwtdebug Bazel: Add missing rule for gerrit-gwtdebug 2016-11-13 10:01:11 -08:00
gerrit-gwtexpui Expose sources in GWT UI plugin API 2016-11-22 22:16:18 +00:00
gerrit-gwtui Fix bug in the MessageOfTheDayBar class 2016-12-02 19:28:39 +00:00
gerrit-gwtui-common Add ApprovalInfo.permittedVotingRange and updated reviewers tooltip 2016-12-02 10:46:23 +01:00
gerrit-httpd Don't show 'Save for Review' button if refs/meta/config is not visible 2016-12-02 09:27:48 +01:00
gerrit-launcher Bazel: Fix testing plugins with acceptance framework 2016-11-16 08:27:12 -08:00
gerrit-lucene Organize imports 2016-11-30 11:14:02 +09:00
gerrit-main Merge changes from topic 'bazel-build' 2016-09-20 11:57:48 +00:00
gerrit-oauth OAuthTokenCache: Use account id as key 2016-10-18 23:37:24 +02:00
gerrit-openid Move AuthType from gerrit-reviewdb to extension API 2016-08-23 17:27:50 +09:00
gerrit-patch-commonsnet Merge branch 'stable-2.12' 2016-08-18 09:09:43 -04:00
gerrit-patch-jgit bazel: put source jars in the same package. 2016-11-30 08:48:20 +01:00
gerrit-pgm ConsoleUI: Add a method to output an error to stderr 2016-11-30 15:58:33 +09:00
gerrit-plugin-api Set version to 2.12.7 2016-11-22 13:49:05 +09:00
gerrit-plugin-archetype Set version to 2.12.7 2016-11-22 13:49:05 +09:00
gerrit-plugin-gwt-archetype Set version to 2.12.7 2016-11-22 13:49:05 +09:00
gerrit-plugin-gwtui Expose sources in GWT UI plugin API 2016-11-22 22:16:18 +00:00
gerrit-plugin-js-archetype Set version to 2.12.7 2016-11-22 13:49:05 +09:00
gerrit-prettify Expose sources in GWT UI plugin API 2016-11-22 22:16:18 +00:00
gerrit-reviewdb Generalize Change.Id methods for parsing from refnames 2016-11-30 11:53:22 -05:00
gerrit-server Allow to explicitly specify whom to notify on a change update 2016-12-05 15:03:11 +01:00
gerrit-sshd Allow to continue reindex despite failures 2016-11-30 12:10:52 +00:00
gerrit-util-cli Implement Bazel build 2016-06-14 21:12:02 +02:00
gerrit-util-http Remove Apache DateUtil Dependency 2016-12-02 13:40:00 +01:00
gerrit-util-ssl Implement Bazel build 2016-06-14 21:12:02 +02:00
gerrit-war Set version to 2.12.7 2016-11-22 13:49:05 +09:00
lib bazel: put source jars in the same package. 2016-11-30 08:48:20 +01:00
plugins Merge "Bazel: Generate source dir for plugins in eclipse classpath" 2016-11-25 10:10:52 +00:00
polygerrit-ui Merge "Add ability for PG plugins to access serverInfo" 2016-12-04 05:55:38 +00:00
ReleaseNotes Replace 2.12.x and 2.13.x release notes with links to homepage 2016-10-19 18:08:51 +09:00
tools Bazel: Fix eclipse classpath generation 2016-12-01 08:48:23 +01:00
website/releases Fix Diffy logo on release page by encoding the image 2015-12-29 10:36:39 -08:00
.bazelproject Ignore buck-out in IntelliJ's Bazel plugin 2016-11-11 10:29:35 -08:00
.buckconfig Merge branch 'stable-2.13' 2016-09-21 11:35:53 +02:00
.buckversion Update buck to latest version 2016-11-30 16:51:31 -08:00
.editorconfig Added continuation indent to editorconfig 2016-04-26 14:42:58 +02:00
.gitignore Git-ignore .primary_build_tool and .gwt_work_dir 2016-11-25 16:51:19 +01:00
.gitmodules Adapt .gitmodules to enable superproject subscriptions 2016-07-27 12:01:40 -07:00
.mailmap Fix .mailmap 2016-10-17 14:03:40 +09:00
.pydevproject Update PyDev project to use Python 2.7 2014-10-02 15:16:44 +09:00
.watchmanconfig Watchman: Add eclipse-out to ignored directories 2016-01-22 08:04:24 +01:00
BUCK Buck: Build gwtgerrit without touching PolyGerrit deps 2015-12-01 07:29:21 +00:00
BUILD Bazel: Fix visibility for //: rules 2016-11-05 00:50:30 +01:00
COPYING Initial project setup of Gerrit 2 2008-11-14 16:59:34 -08:00
INSTALL Remove Gerrit 1.x to 2.x import tools 2009-03-27 20:20:10 -07:00
README.md Add Gerrit install for Fedora and Docker 2016-10-27 08:29:41 +01:00
SUBMITTING_PATCHES Update push URL in SUBMITTING_PATCHES 2012-03-29 00:57:14 -04:00
version.bzl Bazel: Publish maven artifacts to local and remote repositories 2016-11-03 12:47:24 +00:00
WORKSPACE Update JGit to 4.5.0.201609210915-r.115-g81f9c1843 2016-11-21 14:10:02 -08:00

Gerrit Code Review

Gerrit is a code review and project management tool for Git based projects.

Build Status

Objective

Gerrit makes reviews easier by showing changes in a side-by-side display, and allowing inline comments to be added by any reviewer.

Gerrit simplifies Git based project maintainership by permitting any authorized user to submit changes to the master Git repository, rather than requiring all approved changes to be merged in by hand by the project maintainer.

Documentation

For information about how to install and use Gerrit, refer to the documentation.

Source

Our canonical Git repository is located on googlesource.com. There is a mirror of the repository on Github.

Reporting bugs

Please report bugs on the issue tracker.

Contribute

Gerrit is the work of hundreds of contributors. We appreciate your help!

Please read the contribution guidelines.

Note that we do not accept Pull Requests via the Github mirror.

Getting in contact

The IRC channel on freenode is #gerrit. An archive is available at: echelog.com.

The Developer Mailing list is repo-discuss on Google Groups.

License

Gerrit is provided under the Apache License 2.0.

Build

Install Buck and run the following:

    git clone --recursive https://gerrit.googlesource.com/gerrit
    cd gerrit && buck build release

Install binary packages (Deb/Rpm)

The instruction how to configure GerritForge/BinTray repositories is here

On Debian/Ubuntu run:

    apt-get update & apt-get install gerrit=<version>-<release>

NOTE: release is a counter that starts with 1 and indicates the number of packages that have been released with the same version of the software.

On CentOS/RedHat run:

    yum clean all && yum install gerrit-<version>[-<release>]

On Fedora run:

    dnf clean all && dnf install gerrit-<version>[-<release>]

Use pre-built Gerrit images on Docker

Docker images of Gerrit are available on DockerHub

To run a CentOS 7 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-centos7[:version]

To run a Ubuntu 15.04 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-ubuntu15.04[:version]

NOTE: release is optional. Last released package of the version is installed if the release number is omitted.