Google Git
Sign in
gerrit / bazlets / 56c9f4ed6dbe3c88f793851c88389637f3714a5d
commit56c9f4ed6dbe3c88f793851c88389637f3714a5d[log] [tgz]
authorDavid Ostrovsky <david@ostrovsky.org>Thu Jun 11 21:44:03 2020 +0200
committerDavid Ostrovsky <david@ostrovsky.org>Thu Jun 11 22:03:39 2020 +0200
treeb27128e287f710f66e619e77d31d7ac6b8c0ba73
parentfff6f20bb2eceaf872a8acf8ad51471c25a82d38 [diff]
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
  6. COPYING
  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
  13. README.md
  14. rules_python.bzl
  15. 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