Google Git
Sign in
gerrit / modules / git-refs-filter / 23cc86cdeffcdc8907fdfce3dcd2a1afe8bee099
commit23cc86cdeffcdc8907fdfce3dcd2a1afe8bee099[log] [tgz]
authorDavid Ostrovsky <david@ostrovsky.org>Fri Jan 31 19:13:05 2020 +0100
committerDavid Ostrovsky <david@ostrovsky.org>Sat Feb 01 08:46:42 2020 +0100
tree0bfce067dc562cdb627aece75e62355abf52556f
parentf7e73ec0bbf0f4d36ba61c8a008f051d918189f5 [diff]
Adjust to core moving to List interface for ref filtering

Change I1f60c3ca0 changed the API to List interface for ref filtering.

Change-Id: I90e73625bd8276e13cf373ad9360b5658cb61516
1 file changed
tree: 0bfce067dc562cdb627aece75e62355abf52556f
  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.