| commit | fc844142d3f85ba686df0c919df274d38876eabc | [log] [tgz] |
|---|---|---|
| author | David Ostrovsky <david@ostrovsky.org> | Fri Sep 06 09:56:42 2019 +0200 |
| committer | David Pursehouse <dpursehouse@collab.net> | Fri Sep 06 15:59:50 2019 +0900 |
| tree | 5deb87364b051b9d11e3c17ee128111b90277f70 | |
| parent | 4e6783e59b2ff594470c13140ab0e6ed74fafef8 [diff] |
Bazel: Export rules_python in plugin API This is a preparation to flip this option: --incompatible_load_python_rules_from_bzl in Bazel core. Given, that almost all plugins that support standalone build mode use eclipse project generation, we prefer to export this external dependency in Bazlets and avoid including these bits (and the upgrading procedure) in every plugin. Change-Id: I11096db9594a2b67bdd462e354755fcdd8b69ac7
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_github_davido_bazlets", remote = "https://github.com/davido/bazlets.git", commit = "2ede19cb2d2dd9d04bcb70ffc896439a27e5d50d", ) load("@com_github_davido_bazlets//:gerrit_api.bzl", "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_maven_local.bzl", "gerrit_api_maven_local") gerrit_api_maven_local()
Suppose you have the following directory structure for a simple plugin:
[workspace]/
WORKSPACE
BUILD
src/main/java/
src/main/resources/
[...]
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"]), gwt_module = "com.googlesource.gerrit.plugins.reviewers.ReviewersForm", 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, gwt_module, deps, manifest_entries):
<name>.jar: library containing built plugin jar