| commit | 59ddbc9aea4fd52097d7791d70568f7564c27ac7 | [log] [tgz] |
|---|---|---|
| author | Christian Aistleitner <christian@quelltextlich.at> | Fri Jun 12 11:12:26 2020 +0200 |
| committer | Christian Aistleitner <christian@quelltextlich.at> | Fri Jun 12 16:15:49 2020 +0200 |
| tree | 61fcc2a934e17ff5be2959b2d4849a3c968476a6 | |
| parent | 162815cee18c8f3547590743e15269b0c8ed79a2 [diff] |
Allow plugins to override default API versions Thereby, one no longer needs to have a local bazlet checkout and adjust versions there when using snapshot API in a given version. This can now all be done in the plugin alone using a public bazlet version. Change-Id: I679c867008728181e32502e95caa144cdba73581
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.0.9", plugin_api_sha1 = "dbcadf2c198b1ee1b74678855e8e10b2c403de1f", acceptance_framework_sha1 = "799cb104f2c0de4394528e38ad487557dd69bb49")
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.0.10-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