Add repository rule to provide gerrit api version

In I0a786a91147 Gerrit-ApiVersion attribute was added to the MANIFEST.MF
in plugin rule in tree build mode. This change extends standalone build
mode to do the same.

There is one complication, though, because standalone build mode can use
release plugin API or SNAPSHOT and the resulting api version should be
switched as well. Use repository rule, that generates the version.txt
file and depend on it in plugin rule.

Test Plan:

1. Switch reviewers plugin to using bazlets repository from this commit
2. Confirm that building reviewers plugin with release plugin API would
add the following line to the MANIFEST.MF file:

  Gerrit-ApiVersion: 2.16.21

3. Change to gerrit workspace and publish SNAPSHOT plugin artifacts to
   the local Maven repository
4. Confirm that building reviewers plugin with SNAPSHOT plugin API would
add the following line to the MANIFEST.MF file:

  Gerrit-ApiVersion: 2.16.22-SNAPSHOT

Change-Id: I6f17e6c6bbfd4d6fba7bcda8a3f5fc1403c4dc4e
4 files changed
tree: b27128e287f710f66e619e77d31d7ac6b8c0ba73
  1. lib/
  2. tools/
  3. .gitignore
  4. bouncycastle.bzl
  5. BUILD
  7. gerrit_api.bzl
  8. gerrit_api_maven_local.bzl
  9. gerrit_api_version.bzl
  10. gerrit_gwt.bzl
  11. gerrit_plugin.bzl
  12. gerrit_polymer.bzl
  14. 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_github_davido_bazlets",
  remote = "",
  commit = "2ede19cb2d2dd9d04bcb70ffc896439a27e5d50d",

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:


Basic Example

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


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"]),
    gwt_module = "com.googlesource.gerrit.plugins.reviewers.ReviewersForm",
    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, gwt_module, deps, manifest_entries):

Implicit output target

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