Google Git
Sign in
gerrit / modules / git-refs-filter / f7e73ec0bbf0f4d36ba61c8a008f051d918189f5
commitf7e73ec0bbf0f4d36ba61c8a008f051d918189f5[log] [tgz]
authorLuca Milanesio <luca.milanesio@gmail.com>Sat Jun 01 01:59:10 2019 +0100
committerDavid Ostrovsky <david.ostrovsky@gmail.com>Sat Feb 01 07:45:36 2020 +0000
treeabbab73312c75f7a690e462acc5e727dc4cc48d9
parent2de57f9c71d4273391e7751041f20b8b17090f15 [diff]
Adapt to the latest allowCapability API change on master.

Gerrit master refactored the way integration tests should configure
global capabilities.

Change-Id: Ia3ef6151cbb489da2aba09849cb1e3f2cf330784
1 file changed
tree: abbab73312c75f7a690e462acc5e727dc4cc48d9
  1. src/
  2. .gitignore
  3. BUILD
  4. LICENSE
  5. README.md
README.md

Git Ref filter module for Gerrit

Gerrit lib module to allow filtering out refs in the Git advertizing protocol phase.

How to build

Build this module as it was a Gerrit plugin:

  • Clone Gerrit source tree
  • Clone the git-refs-filter source tree
  • Link the git-refs-filter directory to Gerrit /plugins/git-refs-filter
  • From Gerrit source tree run bazel build plugins/git-refs-filter
  • And for running tests bazel test plugins/git-refs-filter:git_refs_filter_tests
  • The git-refs-filter.jar module is generated under /bazel-genfiles/plugins/git-refs-filter/

How install

Copy git-refs-filter.jar library to Gerrit /lib and add the following one extra settings to gerrit.config:

[gerrit]
  installModule = com.googlesource.gerrit.modules.gitrefsfilter.RefsFilterModule

How to configure filtering

The refsfilter module defines a new global capability called “Filter out closed changes refs”. By default the capability isn't assigned to any user or group, thus the module installation has no side effects.

To enable a group of users of getting a “filtered list” of refs (e.g. CI jobs):

  • Define a new group of users (e.g. Builders)
  • Add a user to that group (e.g. Add ‘jenkins’ to the Builders group)
  • Go to the All-Projects ACLs, add the “Filter out closed changes refs” and assign to the group (e.g. Builders)

NOTE Gerrit makes a super-simplified ACL evaluation if all the projects are globally readable (e.g. project has a READ rule to refs/*). To enable the closed changes filtering you need to disable any global read rule for the group that needs refs filtering.