Build

This plugin is built with Bazel. Two build modes are supported:

• Standalone
• In Gerrit tree.

Standalone build mode is recommended, as this mode doesn't require local Gerrit tree to exist. Moreover, there are some limitations and additional manual steps required when building in Gerrit tree mode (see corresponding sections).

Build standalone

Bazel

To build the plugin, issue the following command:

  bazel build @PLUGIN@

The output is created in

  bazel-bin/@PLUGIN@.jar

To execute the tests run:

  bazel test //...

This project can be imported into the Eclipse IDE:

  ./tools/eclipse/project.sh

Build in Gerrit tree

Bazel

Clone (or link) this plugin to the plugins directory of Gerrit's source tree.

Put the external dependency Bazel build file into the Gerrit /plugins directory, replacing the existing empty one.

  cd gerrit/plugins
  rm external_plugin_deps.bzl
  ln -s @PLUGIN@/external_plugin_deps.bzl .

Then issue

  bazel build plugins/@PLUGIN@

in the root of Gerrit's source tree to build

The output is created in

  bazel-bin/plugins/@PLUGIN@/@PLUGIN@.jar

To execute the tests run either one of:

  bazel test --test_tag_filters=@PLUGIN@ //...
  bazel test plugins/@PLUGIN@:@PLUGIN@_tests

This project can be imported into the Eclipse IDE. Add the plugin name to the CUSTOM_PLUGINS and to the CUSTOM_PLUGINS_TEST_DEPS set in Gerrit core in tools/bzl/plugins.bzl, and execute:

  ./tools/eclipse/project.py

More information about Bazel can be found in the Gerrit documentation.

Back to @PLUGIN@ documentation index