Merge branch 'stable-3.0' into stable-3.1

* stable-3.0:
  Remove duplication of sha1 values; reuse arguments
  Unwrap `load` lines in
  Allow plugins to override default API versions
  Dedupe gerrit_api and gerrit_api_maven_local
  Switch examples from GitHub to Gerrit Review
  Clarify that one needs to call gerrit_api in the
  Re-format example directory tree in

Update the gerrit_api README example so it fits with this target branch.

Change-Id: I9dac03faf80e3bb52ba416843cddb6a057f3fcc6
tree: b8c45f9a71e00afb31427c707924f4d66cae83d9
  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",
load("@com_googlesource_gerrit_bazlets//:gerrit_api.bzl", "gerrit_api")

The version parameter allows to override the default API. For release version numbers, make sure to also provide artifacts' SHA1 sums via the plugin_api_sha1 and acceptance_framework_sha1 parameters:

load("@com_googlesource_gerrit_bazlets//:gerrit_api.bzl", "gerrit_api")
gerrit_api(version = "3.1.6",
           plugin_api_sha1 = "e57f6465c9805f568082bffffd61a2771f10d68a",
           acceptance_framework_sha1 = "ebfd50383f8593678b451c81dbc332db8e8da188")

If the version ends in -SNAPSHOT, the jars are consumed from the local Maven repository (~/.m2) per default assumed to be and the SHA1 sums can be omitted:

load("@com_googlesource_gerrit_bazlets//:gerrit_api.bzl", "gerrit_api")
gerrit_api(version = "3.1.7-SNAPSHOT")

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