The Gerrit server functionality can be extended by installing plugins.
Plugin Installation
Plugin installation is as easy as dropping the plugin jar into the
$site_path/plugins/ folder. It may take
a few minutes until
the server picks up new and updated plugins.
Plugin Development
How to develop plugins is described in the Plugin Development Guide.
If you want to share your plugin under the Apache License 2.0 you can host your plugin development on the gerrit-review Gerrit Server. You can request the creation of a new Project by email to the Gerrit mailing list. You would be assigned as project owner of the new plugin project so that you can submit changes on your own. It is the responsibility of the project owner to maintain the plugin, e.g. to make sure that it works with new Gerrit versions and to create stable branches for old releases.
Core Plugins
Core plugins are packaged within the Gerrit war file and can easily be installed during the Gerrit initialization.
The core plugins are developed and maintained by the Gerrit maintainers and the Gerrit community.
commit-message-length-validator
This plugin checks the length of a commit’s commit message subject and message body, and reports warnings or errors to the git client if the lengths are exceeded.
cookbook-plugin
Sample plugin to demonstrate features of Gerrit’s plugin API.
download-commands
This plugin defines commands for downloading changes in different download schemes (for downloading via different network protocols).
replication
This plugin can automatically push any changes Gerrit Code Review makes to its managed Git repositories to another system. Usually this would be configured to provide mirroring of changes, for warm-standby backups, or a load-balanced public mirror farm.
reviewnotes
Stores review information for Gerrit changes in the refs/notes/review
branch.
singleusergroup
This plugin provides a group per user. This is useful to assign access rights directly to a single user, since in Gerrit access rights can only be assigned to groups.
Other Plugins
Besides core plugins there are many other Gerrit plugins available. These plugins are developed and maintained by different parties. The Gerrit Project doesn’t guarantee proper functionality of any of these plugins.
The Gerrit Project doesn’t provide binaries for these plugins, but there are some public services that offer the download of pre-built plugin jars:
The following list gives an overview about available plugins, but the list may not be complete. You may discover more plugins on gerrit-review.
admin-console
Plugin to provide administrator-only functionality, intended to simplify common administrative tasks. Currently providing user-level information. Also providing access control information by project or project/account.
avatars/external
This plugin allows to use an external url to load the avatar images from.
branch-network
This plugin allows the rendering of Git repository branch network in a graphical HTML5 Canvas. It is mainly intended to be used as a "project link" in a gitweb configuration or by other Gerrit GWT UI plugins to be plugged elsewhere in Gerrit.
changemessage
This plugin allows to display a static info message on the change screen.
codenvy
Plugin to allow to edit code on-line on either an existing branch or an active change using the Codenvy cloud development platform.
egit
This plugin provides extensions for easier usage with EGit.
The plugin adds a download command for EGit that allows to copy only the change ref into the clipboard. The change ref is needed for downloading a Gerrit change from within EGit.
force-draft
Provides an ssh command to force a change or patch set to draft status. This is useful for administrators to be able to easily completely delete a change or patch set from the server.
imagare
The imagare plugin allows Gerrit users to upload and share images.
importer
The importer plugin allows to import projects from one Gerrit server into another Gerrit server.
Projects can be imported while both source and target Gerrit server are online. There is no downtime required.
The git repository and all changes of the project, including approvals and review comments, are imported. Historic timestamps are preserved.
Project imports can be resumed. This means a project team can continue to work in the source system while the import to the target system is done. By resuming the import the project in the target system can be updated with the missing delta.
The importer plugin can also be used to copy a project within one Gerrit server, and in combination with the delete-project plugin it can be used to rename a project.
Issue Tracker System Plugins
Plugins to integrate with issue tracker systems (ITS), that (based on events in Gerrit) allows to take actions in the ITS. For example, they can add comments to bugs, or change status of bugs.
All its-plugins have a common base implementation which is stored in
the its-base project. its-base is not a plugin, but just a
framework for the ITS plugins which is packaged within each ITS plugin.
javamelody
This plugin allows to monitor the Gerrit server.
This plugin integrates JavaMelody in Gerrit in order to retrieve live instrumentation data from Gerrit.
labelui
The labelui plugin adds a user preference that allows users to choose a table control to render the labels/approvals on the change screen (similar to how labels/approvals were rendered on the old change screen).
menuextender
The menuextender plugin allows Gerrit administrators to configure additional menu entries from the WebUI.
motd
This plugin can output messages to clients when pulling/fetching/cloning code from Gerrit Code Review. If the client (and transport mechanism) can support sending the message to the client, it will be displayed to the user (usually prefixed by “remote: ”), but will be silently discarded otherwise.
OAuth authentication provider
This plugin enables Gerrit to use OAuth2 protocol for authentication. Two different OAuth providers are supported:
-
GitHub
-
Google
owners
This plugin provides a Prolog predicate add_owner_approval/3 that
appends label('Owner-Approval', need(_)) to a provided list.
project-download-commands
This plugin adds support for project specific download commands.
Project specific download commands that are defined on a parent project are inherited by the child projects. Child projects can overwrite the inherited download command or remove it by assigning no value to it.
quota
This plugin allows to enforce quotas in Gerrit.
To protect a Gerrit installation it makes sense to limit the resources that a project or group can consume. To do this a Gerrit administrator can use this plugin to define quotas on project namespaces.
ref-protection
A plugin that protects against commits being lost.
Backups of deleted or non-fast-forward updated refs are created under the
refs/backups/ namespace.
reparent
A plugin that provides project reparenting as a self-service for project owners.
reviewers
A plugin that allows adding default reviewers to a change.
reviewers-by-blame
A plugin that allows automatically adding reviewers to a change from the git blame computation on the changed files. It will add the users that authored most of the lines touched by the change, since these users should be familiar with the code and can mostly review the change.
scripting/groovy-provider
This plugin provides a Groovy runtime environment for Gerrit plugins in Groovy.
scripting/scala-provider
This plugin provides a Scala runtime environment for Gerrit plugins in Scala.
server-config
This plugin enables access (download and upload) to the server config
files. It may be used to change Gerrit config files (like
etc/gerrit.config) in cases where direct access to the file system
where Gerrit’s config files are stored is difficult or impossible to
get.
serviceuser
This plugin allows to create service users in Gerrit.
A service user is a user that is used by another service to communicate with Gerrit. E.g. a service user is needed to run the Gerrit Trigger Plugin in Jenkins. A service user is not able to login into the Gerrit WebUI and it cannot push commits or tags.
uploadvalidator
This plugin allows to configure upload validations per project.
Project owners can configure blocked file extensions, required footers and a maximum allowed path length. Pushes of commits that violate these settings are rejected by Gerrit.
websession-flatfile
This plugin replaces the built-in Gerrit H2 based websession cache with a flatfile based implementation. This implemantation is shareable amongst multiple Gerrit servers, making it useful for multi-master Gerrit installations.
wip
This plugin adds a new button that allows a change owner to set a change to Work In Progress, and a button to change from WIP back to a "Ready For Review" state.
Any change in the WIP state will not show up in anyone’s Review Requests. Pushing a new patchset will reset the change to Review In Progress.