Re-usable building blocks for Bazel build tool

Clone this repo:
  1. c9dad39 Update Gerrit to 3.0.0 final release by David Pursehouse · 4 days ago master
  2. 298b25c Update Gerrit API to 3.0.0-rc3 by David Pursehouse · 11 days ago
  3. 3bab941 Update Gerrit API to 3.0.0-rc2 by David Pursehouse · 2 weeks ago
  4. 6b3b25f Merge branch 'stable-2.16' by David Pursehouse · 2 weeks ago
  5. a5525ae Update Gerrit API to 2.16.8 by David Pursehouse · 3 weeks ago stable-2.16

Gerrit Code Review Rules for Bazel

Overview

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

Setup

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.

git_repository(
  name = "com_github_davido_bazlets",
  remote = "https://github.com/davido/bazlets.git",
  commit = "2ede19cb2d2dd9d04bcb70ffc896439a27e5d50d",
)
load("@com_github_davido_bazlets//:gerrit_api.bzl",
     "gerrit_api")

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:

load("@com_googlesource_gerrit_bazlets//:gerrit_api_maven_local.bzl",
     "gerrit_api_maven_local")
gerrit_api_maven_local()

Basic Example

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

[workspace]/
    WORKSPACE
	BUILD
    src/main/java/
	src/main/resources/
	[...]

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

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

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

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

Implicit output target

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