These build rules are used for building Gerrit Code Review
plugins with Bazel. Plugins are compiled as .jar files containing plugin code and
dependencies.
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_googlesource_gerrit_bazlets",
remote = "https://gerrit.googlesource.com/bazlets",
commit = "928c928345646ae958b946e9bbdb462f58dd1384",
)
load("@com_googlesource_gerrit_bazlets//:gerrit_api.bzl", "gerrit_api")
gerrit_api()The version parameter allows to override the default API. For release version
numbers, make sure to also provide artifacts' SHA1 sums via the
plugin_api_sha1 and acceptance_framework_sha1 parameters:
load("@com_googlesource_gerrit_bazlets//:gerrit_api.bzl", "gerrit_api")
gerrit_api(version = "3.2.1",
plugin_api_sha1 = "47019cf43ef7e6e8d2d5c0aeba0407d23c93699c",
acceptance_framework_sha1 = "6252cab6d1f76202e57858fcffb428424e90b128")If the version ends in -SNAPSHOT, the jars are consumed from the local
Maven repository (~/.m2) per default assumed to be and the SHA1 sums can be
omitted:
load("@com_googlesource_gerrit_bazlets//:gerrit_api.bzl", "gerrit_api")
gerrit_api(version = "3.3.0-SNAPSHOT")Suppose you have the following directory structure for a simple plugin:
[workspace]/
├── src
│ └── main
│ ├── java
│ └── resources
├── BUILD
└── WORKSPACE
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(name, srcs, resources, deps, manifest_entries):<name>.jar: library containing built plugin jar
| Attributes | |
|---|---|
name |
Name, required
A unique name for this rule. |
srcs |
List of labels, optional
List of .java source files that will be compiled. |
resources |
List of labels, optional
List of resource files that will be passed on the classpath to the Java compiler. |
deps |
List of labels, optional
List of other java_libraries on which the plugin depends. |
manifest_entries |
List of strings, optional
A list of lines to add to the META-INF/manifest.mf file generated for the *_deploy.jar target. |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent