Google Git
Sign in
gerrit / modules / git-refs-filter / 2de57f9c71d4273391e7751041f20b8b17090f15
commit2de57f9c71d4273391e7751041f20b8b17090f15[log] [tgz]
authorJohn Viklund <john.viklund@effnet.com>Mon Dec 16 08:06:07 2019 +0100
committerJohn Viklund <john.viklund@effnet.com>Mon Dec 16 08:06:07 2019 +0100
tree13cbda0e316e3b24f55525a82df04832bd0d724c
parent0d35f594e4f0b085dad2f461e95b728df93fbec6 [diff]
Remove explicit Project.NameKey import

Change-Id: I9d381251b66c4ed77d54780033ef309724e66734
2 files changed
tree: 13cbda0e316e3b24f55525a82df04832bd0d724c
  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.