Google Git
Sign in
gerrit / bazlets / cd715d269734e7bb0aa2fc4a01d2d2e279631cc7
commitcd715d269734e7bb0aa2fc4a01d2d2e279631cc7[log] [tgz]
authorMarco Miller <marco.miller@ericsson.com>Fri Mar 27 11:11:20 2020 -0400
committerMarco Miller <marco.miller@ericsson.com>Fri Mar 27 11:11:20 2020 -0400
tree4633c240cdcfe1cf1feb04878f0b8e6f29aad69f
parent2add9fecf8bec8634bddf354815bd0fa93f58dd5 [diff]
parentfc1bfdf008c4b07e7cc4214fdacf25560276f9c4 [diff]
Merge branch 'stable-3.1'

* stable-3.1:
  Update Gerrit API to 3.1.4
  Update Gerrit API to 2.16.17
  Update Gerrit API to 3.0.8

Change-Id: Ib03b93538dc4a738c30b7a3553eba03bd4935ce6
tree: 4633c240cdcfe1cf1feb04878f0b8e6f29aad69f
  1. lib/
  2. tools/
  3. .gitignore
  4. bouncycastle.bzl
  5. BUILD
  6. COPYING
  7. gerrit_api.bzl
  8. gerrit_api_maven_local.bzl
  9. gerrit_plugin.bzl
  10. gerrit_polymer.bzl
  11. README.md
  12. rules_python.bzl
  13. WORKSPACE
README.md

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