blob: 7dd192766b27f1ba147554d9a2bc2f87652a770d [file] [log] [blame] [view]
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 quota plugin directory:
```
cd quota && ln -s ../bucklets .
```
Add link to the .buckversion file:
```
cd quota && ln -s bucklets/buckversion .buckversion
```
Add link to the .watchmanconfig file:
```
cd server-config && ln -s bucklets/watchmanconfig .watchmanconfig
```
To build the plugin, issue the following command:
```
buck build plugin
```
The output is created in
```
buck-out/gen/quota.jar
```
Test are executed with
```
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/quota
```
The output is created in
```
buck-out/gen/plugins/quota/quota.jar
```
This project can be imported into the Eclipse IDE:
```
./tools/eclipse/project.py
```
Test are executed with
```
buck test --include quota-plugin
```
Maven
-----
Note that the Maven build is provided for compatibility reasons, but
it is considered to be deprecated and will be removed in a future
version of this plugin.
To build with Maven, run
```
mvn clean package
```