| commit | 162815cee18c8f3547590743e15269b0c8ed79a2 | [log] [tgz] |
|---|---|---|
| author | Christian Aistleitner <christian@quelltextlich.at> | Fri Jun 12 10:47:59 2020 +0200 |
| committer | Christian Aistleitner <christian@quelltextlich.at> | Fri Jun 12 13:39:44 2020 +0200 |
| tree | 2b49d32e4d3a6e06230d54a7468994182148c989 | |
| parent | 28ba844a04ba5cc514ad8ee071f70fa02e63a32b [diff] |
Dedupe gerrit_api and gerrit_api_maven_local Much of the code was shared between gerrit_api and gerrit_api_maven_local. This made it easy to miss version numbers when updating. And it means much commenting/uncommenting when switching a Gerrit plugin from a released API to a local one and vice-versa. By bringing all the needed logic directly into `gerrit_api` we now have a single canonical place for the used Gerrit API version, which follow-up commits can use for stamping. And switching a Gerrit plugin's standalone build from a released API version to a local one becomes much simpler. Change-Id: Ib638ee1a1791ffd720aabd7539597f89206ab957
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()
Another option is to consume snapshot version of gerrit plugin API from local Maven repository (~/.m2). To use the snapshot version special method is provided:
load("@com_googlesource_gerrit_bazlets//:gerrit_api.bzl", "gerrit_api") gerrit_api(local_repository = True)
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