| commit | 41882840cacf1909646d90b83f661613b51f78ff | [log] [tgz] |
|---|---|---|
| author | Nasser Grainawi <nasser.grainawi@linaro.org> | Thu Nov 30 16:36:36 2023 -0700 |
| committer | Nasser Grainawi <nasser.grainawi@linaro.org> | Thu Nov 30 16:36:36 2023 -0700 |
| tree | 64a2f55d26bdbb1d53a66766ac57960584970dac | |
| parent | cd9b114339913aad2c9981e387fd151123f40a44 [diff] |
Adapt gerrit_plugin rule to removal of resource_jars attribute In Bazel release 5.0 resource_jars attribute was removed: [1]. Apply the same fix that core did in Change I3b49112b65a4. Preserve the attribute as-is to not change the caller sites and pass in the resource jars collection to runtime_deps as recommended. [1] https://github.com/bazelbuild/bazel/issues/13221 Change-Id: Id47aaf60afaa637e9b233f925285c8d2a79a756e
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