commit | bd8db0cf3057397bcf7287c28cc93886e663989b | [log] [tgz] |
---|---|---|
author | Marco Miller <marco.miller@ericsson.com> | Mon Jun 15 10:34:04 2020 -0400 |
committer | Marco Miller <marco.miller@ericsson.com> | Mon Jun 15 16:11:32 2020 -0400 |
tree | b8c45f9a71e00afb31427c707924f4d66cae83d9 | |
parent | b2e8c183da6c54306596f2a5445cc638044a0bc3 [diff] | |
parent | 2629e3802493a45cdc7a3e03deb3331743daa09c [diff] |
Merge branch 'stable-3.0' into stable-3.1 * stable-3.0: Remove duplication of sha1 values; reuse arguments Unwrap `load` lines in README.md Allow plugins to override default API versions Dedupe gerrit_api and gerrit_api_maven_local Switch examples from GitHub to Gerrit Review Clarify that one needs to call gerrit_api in the README.md Re-format example directory tree in README.md Update the gerrit_api README example so it fits with this target branch. Change-Id: I9dac03faf80e3bb52ba416843cddb6a057f3fcc6
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.1.6", plugin_api_sha1 = "e57f6465c9805f568082bffffd61a2771f10d68a", acceptance_framework_sha1 = "ebfd50383f8593678b451c81dbc332db8e8da188")
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.1.7-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