Google Git
Sign in
gerrit / modules / global-refdb / fa7c1dcd3c3949678e9c183d5ce3f6bb66bfc993
commitfa7c1dcd3c3949678e9c183d5ce3f6bb66bfc993[log] [tgz]
authorLuca Milanesio <luca.milanesio@gmail.com>Wed May 17 00:57:17 2023 +0100
committerLuca Milanesio <luca.milanesio@gmail.com>Thu May 18 20:39:31 2023 +0000
tree2239858496ccc6f205fcfb0bca81d549150710d8
parentb343ee7cbf796bc567d53c0d133db511e128fb97 [diff]
Add Bazel build instructions

Include how to build the libModule using Bazel in the README.md.

This represents a stepping stone moving away from Maven's build.

Change-Id: I631fd89a9282857cc6e359388df4d7e0907410cc
1 file changed
tree: 2239858496ccc6f205fcfb0bca81d549150710d8
  1. src/
  2. .gitignore
  3. bindings.md
  4. BUILD
  5. config.md
  6. Jenkinsfile
  7. LICENSE
  8. metrics.md
  9. pom.xml
  10. README.md
README.md

Gerrit interface to a global-refdb

Global ref-database interface for use with Gerrit Code Review.

Enables the de-coupling between Gerrit, its libModules and the different implementations of a globally shared ref-database.

Design

The design for a global ref-db interface can be found as part of the multi-site design documentation, where it first originated and was approved by the community.

Bindings

In order to consume this library, some Guice bindings need to be registered appropriately. More information in the relevant documentation.

Metrics

Global ref-database expose metrics to measure the global ref-database operation latency. List of the available metrics can be found here.

How to build

This libModule is built like a Gerrit in-tree plugin, using Bazelisk.

Build in Gerrit tree

Create a symbolic link of the repository source to the Gerrit source tree /plugins/global-refdb directory.

Example:

git clone https://gerrit.googlesource.com/gerrit git clone https://gerrit.googlesource.com/modules/global-refdb cd gerrit/plugins ln -s ../../global-refdb . From the Gerrit source tree issue the command bazelsk build plugins/global-refdb

Example:

bazelisk build plugins/global-refdb

The libModule jar file is created under basel-bin/plugins/global-refdb/global-refdb.jar

To execute the tests run bazelisk test plugins/global-refdb/... from the Gerrit source tree.

Example:

bazelisk test plugins/global-refdb/...

How to import into Eclipse as a project

Add global-refdb in the CUSTOM_PLUGINS section of the tools/bzl/plugins.bzl.

Example:

CUSTOM_PLUGINS = [
    "global-refdb",
]

Run tools/eclipse/project.py for generating or updating the Eclipse project.