commit | b2b8548d08210429319afcabc0c7719b281561ba | [log] [tgz] |
---|---|---|
author | Antoine Musso <hashar@free.fr> | Mon Jun 27 20:30:15 2022 +0200 |
committer | Antoine Musso <hashar@free.fr> | Mon Jun 27 20:30:15 2022 +0200 |
tree | f10288674fb62d6b200f657cc450a6554e84832f | |
parent | d76d5db807ccfed0028cd3d7afda60af5f2e3353 [diff] |
download to GERRIT_CACHE_HOME when set When building a plugin as user `nobody`, download_file is unable to write the artifacts to the cache since the user does not have a home directory. For a CI build I also need to be set the cache directory to a predetermined value. Introduce the optional `GERRIT_CACHE_HOME` environment variable to support relocating downloaded artifacts. When the environment variable is not set, behavior is unchanged. Update documentation to mention support for `GERRIT_CACHE_HOME`. While at it, explain how to override the bazel repository and disk cache, would have same a bit of time the first time I had to tweak them. This was done in Gerrit with Ie4fac83928527e0e71b159b9500983234c2261ac Change-Id: I0c4b3992d36cf40196f64251900f07e527d8a3c4
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