| commit | 15b898ac88f1a9c0b250526e8468111b5270add7 | [log] [tgz] |
|---|---|---|
| author | David Pursehouse <dpursehouse@collab.net> | Fri Mar 01 16:33:14 2019 +0900 |
| committer | David Pursehouse <dpursehouse@collab.net> | Fri Mar 01 08:34:37 2019 +0000 |
| tree | ee9bbcfe3c55fde72ad0c0f77d50bbee64aacc6d | |
| parent | 91881dd6029998abd7fbb769f42bbbfe5d06f23f [diff] |
Bazel: Automatically fix lint errors with buildifier
In recent buildifier versions, lint errors can be fixed automatically:
$ find . \( -name BUILD -o -name "*.bzl" \) -print \
| xargs buildifier --lint=fix
The exporting of unused "PLUGIN_DEPS" and "PLUGIN_TEST_DEPS" in
gerrit_plugin.bzl was preserved, because the standalone build mode
depends on it.
This commit was created with Buildifier version 0.20.0:
$ buildifier --version
buildifier version: 0.20.0
buildifier scm revision: db073457c5a56d810e46efc18bb93a4fd7aa7b5e
Change-Id: I956bc89603a8b3364551c6915edbd2ffe651c421
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