Google Git
Sign in
gerrit / bazlets / 60e20314a1c8208c37b3e85f7daffb7d0372e965
commit60e20314a1c8208c37b3e85f7daffb7d0372e965[log] [tgz]
authorDavid Pursehouse <dpursehouse@collab.net>Mon Apr 08 09:14:15 2019 +0900
committerDavid Pursehouse <dpursehouse@collab.net>Mon Apr 08 09:18:49 2019 +0900
tree60fe94e0f6d32f9bad743fcafe4970a63d0ec314
parenta8ba0d6d03944ea1ab5ae5e9eb44397ee4b17bb5 [diff]
Fix default label in java_doc rule

The merge done in I81f95eee0 contains an incorrect conflict resolution,
which causes "bazel test //..." to fail in the gitiles project with:

  <input file target @local_jdk//:bin/javadoc> doesn't contain declared provider 'ToolchainInfo'

Change-Id: I482a3ec7398a149760c6f450683b12fc9f4fad70
1 file changed
tree: 60fe94e0f6d32f9bad743fcafe4970a63d0ec314
  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. gerrit_polymer.bzl
  12. README.md
  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"]),
    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