@PLUGIN@ Build

This plugin can be built with Buck or Maven.

Buck

Two build modes are supported: Standalone and in Gerrit tree. The standalone build mode is recommended, as this mode doesn't require the Gerrit tree to exist locally.

Build standalone

Clone bucklets library:

  git clone https://gerrit.googlesource.com/bucklets

and link it to @PLUGIN@ plugin directory:

  cd @PLUGIN@ && ln -s ../bucklets .

Add link to the .buckversion file:

  cd @PLUGIN@ && ln -s bucklets/buckversion .buckversion

Add link to the .watchmanconfig file:

  cd @PLUGIN@ && ln -s bucklets/watchmanconfig .watchmanconfig

To build the plugin, issue the following command:

  buck build plugin

The output is created in

  buck-out/gen/@PLUGIN@.jar

To execute the tests run:

  buck test

Build in Gerrit tree

Clone or link this plugin to the plugins directory of Gerrit's source tree, and issue the command:

  buck build plugins/@PLUGIN@

The output is created in

  buck-out/gen/plugins/@PLUGIN@/@PLUGIN@.jar

This project can be imported into the Eclipse IDE:

  ./tools/eclipse/project.py

To execute the tests run:

  buck test --include @PLUGIN@

Maven

Note that for compatibility reasons a Maven build is provided, but is considered to be deprecated and will be removed in a future version of this plugin.

To build with Maven, change directory to the plugin folder and issue the command:

  mvn clean package

When building with Maven, the Gerrit Plugin API must be available.

How to build the Gerrit Plugin API is described in the Gerrit documentation.