| commit | 2ad931eb07d5a43c7a26132716a1411a47fcbfdf | [log] [tgz] |
|---|---|---|
| author | David Ostrovsky <david@ostrovsky.org> | Sun Mar 15 08:11:25 2020 +0100 |
| committer | David Ostrovsky <david@ostrovsky.org> | Sun Mar 15 08:11:25 2020 +0100 |
| tree | a939b061cb5cd12c94e6501f828f08b2a2f04df2 | |
| parent | 1b6fc9b39001806b37a4eedbb0a4816daf1a227d [diff] |
Bazel: Update time attribute of file entries in plugin artifact Due to this Bazel issue: [1] non .class file entries are normalized in singlejar Bazel utility. As the consequence even JavaScript and HTML files have the timestamp: 2010-01-01 00:00. This makes it problematic to refresh the plugin artifacts in browser because of the cache if a new plugin version is deployed in Gerrit server. To rectify, touch the content of the plugin artifact in stamp action. The 'touch' command uses the system default timezone if none is supplied. This makes zip files dependent on the timezone of the generating machine. Zip by default stores extended attributes (eg. ctime, atime) on Unix systems. These can be further sources of non-determinism, so switch it off with --no-extra. [1] https://github.com/bazelbuild/bazel/issues/10789 Bug: Issue 12349 Change-Id: I5b3bbba8a3df15f37ab1a21c48768697e8bd2f36
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