Dedupe gerrit_api and gerrit_api_maven_local

Much of the code was shared between gerrit_api and
gerrit_api_maven_local. This made it easy to miss version numbers when
updating. And it means much commenting/uncommenting when switching a
Gerrit plugin from a released API to a local one and vice-versa.

By bringing all the needed logic directly into `gerrit_api` we now have
a single canonical place for the used Gerrit API version, which
follow-up commits can use for stamping. And switching a Gerrit plugin's
standalone build from a released API version to a local one becomes
much simpler.

Change-Id: Ib638ee1a1791ffd720aabd7539597f89206ab957
3 files changed
tree: 2b49d32e4d3a6e06230d54a7468994182148c989
  1. lib/
  2. tools/
  3. .gitignore
  4. bouncycastle.bzl
  5. BUILD
  7. gerrit_api.bzl
  8. gerrit_api_version.bzl
  9. gerrit_plugin.bzl
  10. gerrit_polymer.bzl
  12. rules_python.bzl

Gerrit Code Review Rules for Bazel


These build rules are used for building Gerrit Code Review plugins with Bazel. Plugins are compiled as .jar files containing plugin code and dependencies.


To be able to use the Gerrit rules, you must provide bindings for the plugin API jars. The easiest way to do so is to add the following to your WORKSPACE file, which will give you default versions for Gerrit plugin API.

  name = "com_googlesource_gerrit_bazlets",
  remote = "",
  commit = "928c928345646ae958b946e9bbdb462f58dd1384",

Another option is to consume snapshot version of gerrit plugin API from local Maven repository (~/.m2). To use the snapshot version special method is provided:

gerrit_api(local_repository = True)

Basic Example

Suppose you have the following directory structure for a simple plugin:

├── src
│   └── main
│       ├── java
│       └── resources

To build this plugin, your BUILD can look like this:

load("//tools/bzl:plugin.bzl", "gerrit_plugin")

    name = "reviewers",
    srcs = glob(["src/main/java/**/*.java"]),
    manifest_entries = [
        "Gerrit-PluginName: reviewers",
        "Gerrit-Module: com.googlesource.gerrit.plugins.reviewers.Module",
    resources = glob(["src/main/**/*"]),

Now, you can build the Gerrit plugin by running bazel build <plugin>.

For a real world example, see the reviewers plugin.


gerrit_plugin(name, srcs, resources, deps, manifest_entries):

Implicit output target

  • <name>.jar: library containing built plugin jar