Merge branch 'master' into stable-2.13

* master:
  Fix OWNERS examples YAML formatting
  Fix matchers-only OWNERS config
  Align all license headers to the Std Gerrit one
  Update documentation with the latest features.
  Fix typo in matchers configuration
  Make owners requirements explicit
  Extra prolog predicates to extract files and owners
  Extract accounts resolution from Gerrit's resolver
  Include config.md in plugins' documentation
  Added PartialRegExMatcher.
  owners-plugin based on files instead of matchers.
  FileOwners added and UnitTested
  owners-autoassign updated to support new owners
  Matching based rules in OWNERS config
  Added unit-tests for parsing OWNERS configuration
  Factor out JGit operations into a Helper

Change-Id: Ib1c0ac8f66a4d44a8997e243de636d45e5af433c
tree: f99a6f168e84cf888e1521e69ae47045d010dcb3
  1. owners/
  2. owners-autoassign/
  3. owners-common/
  4. .buckconfig
  5. .gitignore
  6. CHANGELOG
  7. config.md
  8. external_plugin_deps.bzl
  9. LICENSE
  10. README.md
README.md

Gerrit OWNERS Plugin

This plugin provides some Prolog predicates that can be used to add customized validation checks based on the approval of ‘path owners’ of a particular folder in the project.

That allows creating a single big project including multiple components and users have different roles depending on the particular path where changes are being proposed. A user can be “owner” in a specific directory, and thus influencing the approvals of changes there, but cannot do the same in others paths, so assuring a kind of dynamic subproject access rights.

How it works

There are currently two main prolog public verbs:

add_owner_approval/3 (UserList, InList, OutList) appends label('Owner-Approval', need(_)) to InList building OutList if UserList has no users contained in the defined owners of this path change.

In other words, the predicate just copies InList to OutList if at least one of the elements in UserList is an owner.

add_owner_approval/2 (InList, OutList) appends label('Owner-Approval', need(_)) to InList building OutList if no owners has given a Code-Review +2 to this path change.

This predicate is similar to the first one but generates a UserList with an hardcoded policy.

Since add_owner_approval/3 is not using hard coded policies, it can be suitable for complex customizations.

Auto assigner

There is a second plugin, gerrit-owners-autoassign which depends on gerrit-owners. It will automatically assign all of the owners to review a change when it's created or updated.

How to build

Create three symbolic links of the owners-owners, owners-common and owners-autoassign from the Gerrit source code /plugins directory to the subdirectories of this project.

Then build the owners and owners-autoassign plugins with the usual Gerrit plugin compile command.

NOTE: This plugin requires Java 8, even if Gerrit 2.13 can be built with Java 7. To enable Java 8 when building this plugin, append the .buckconfig to the Gerrit's one.

Example:

   $ git clone https://gerrit.googlesource.com/plugins/owners
   $ git clone https://gerrit.googlesource.com/gerrit
   $ cd gerrit/plugins
   $ ln -s ../../owners/owners* .
   $ cd ..
   $ cat ../owners/.buckconfig >> .buckconfig
   $ buck test plugins/owners-common:test
   $ buck build plugins/owners plugins/owners-autoassign

NOTE: the owners-common folder is producing shared artifacts for the two plugins and does not need to be built separately being a direct dependency of the build process. Its resulting .jar must not be installed in gerrit plugins directory.