Google Git
Sign in
gerrit / modules / git-refs-filter / 770f3a53fe8a980d39af5aceafd3dbb3ac41c81a
commit770f3a53fe8a980d39af5aceafd3dbb3ac41c81a[log] [tgz]
authorLuca Milanesio <luca.milanesio@gmail.com>Wed Sep 15 01:13:16 2021 +0100
committerLuca Milanesio <luca.milanesio@gmail.com>Wed Sep 22 23:14:26 2021 +0100
tree61ca7c6d4aa4b5da5862937b01c6b32f812c8a30
parente8972220200f8abab76825a84c5c9bb339939bf8 [diff]
Filter out non-existent changes from advertised refs

The project may contain refs that are not associated to
any change, possibly because of corruption issues or errors
in migrating them to NoteDb.

Consider any non-existent changes as non-existent refs and
avoid serving them in the advertised refs list.

Change-Id: I8df20d299f753fdbf206503f8ca02bff99d8b7e6
2 files changed
tree: 61ca7c6d4aa4b5da5862937b01c6b32f812c8a30
  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.

Filtering a closed change refs has the following meaning:

  • Merged changes and all their patch-sets
  • Abandoned changes and all their patch-sets
  • Corrupted changes and all their patch-sets
  • All ‘/meta’ refs of all changes

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.