Google Git
Sign in
gerrit / bazlets / 3a53199198db3f49a43b7708c2c3352670393717
commit3a53199198db3f49a43b7708c2c3352670393717[log] [tgz]
authorDave Borowitz <dborowitz@google.com>Fri Jun 08 10:46:21 2018 -0400
committerDave Borowitz <dborowitz@google.com>Fri Jun 08 10:49:12 2018 -0400
treedb5b3cf2a3580202713c633938d45518ae018f88
parent4459b9706a6eedb8453a98d4434fb3bc4db84211 [diff]
Add optional dir_name argument to gerrit_plugin

This allows the plugin to live in a directory name that doesn't exactly
match the plugin name. Without this change, building such a plugin will
fail since the STABLE_BUILD_*_LABEL var won't be found in the stamp info
file.

Change-Id: Ifc7a9e57f25cfe85a6a7dc6479ff47ad0d175ae9
1 file changed
tree: db5b3cf2a3580202713c633938d45518ae018f88
  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_gwt.bzl
  10. gerrit_plugin.bzl
  11. README.md
  12. 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"]),
    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

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

Implicit output target

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