commit | 1dd03e38f46e56defc91b6ab4a4d9879f6083de1 | [log] [tgz] |
---|---|---|
author | Aditya Gupta <agaditya@codeaurora.org> | Wed Aug 25 22:21:59 2021 +0530 |
committer | Aditya Gupta <agaditya@codeaurora.org> | Fri Sep 03 19:52:22 2021 +0530 |
tree | cc318e82dabd283f440e3fedd19ebd3231d02f71 | |
parent | f96f4bce9ffafeaa200fc009a378921c512fcb0a [diff] |
Add eslint rule Eslint rule is used to lint java script files. To use eslint rule, its dependencies in "tools/js" directory from gerrit core are needed in the current workspace, this can be avoided by adding this rule to bazlets project. Any plugin that need eslint rule can reuse eslint rule of bazlets project with minimum required dependencies. eslint rule is added to bazlets by referring following location : https://gerrit.googlesource.com/gerrit/ +/refs/heads/stable-3.2/tools/js/eslint.bzl Also add "build_bazel_rules_nodejs" since this is required dependency for eslint rule. "build_bazel_rule_nodejs" dependency is added to bazlets from following location : https://gerrit.googlesource.com/bazlets/ +/refs/heads/stable-3.3/gerrit_polymer.bzl Change-Id: Iab68492a9e847d53377fd2eb24e22c01ec6d0142
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