| commit | dd77ddb0cf5945d7553f1a747cc74b88f7240c26 | [log] [tgz] |
|---|---|---|
| author | Luca Milanesio <luca.milanesio@gmail.com> | Wed Apr 28 22:35:45 2021 +0100 |
| committer | Luca Milanesio <luca.milanesio@gmail.com> | Mon May 24 18:10:10 2021 +0100 |
| tree | eba97a442b9a3d351f2b9826e30e1ccfa5e1cdd3 | |
| parent | f3335231b98e14664fdd1b325486bb0824800ac3 [diff] |
Allow custom initial attention-set from owners
Avoid adding too many reviewers automatically to the attention-set
when a change is created. The OWNERS list, because of hierarchy, may
pull a lot of names as reviewers, but that doesn't mean that all of them
should have the initial task to provide the first feedback.
Expose an API (OwnersAttentionSet that allows an external script
or plugin to specify the logic for selecting the accounts for the
attention set based on:
- Owners
- Change
The new API is contained in owners-api.jar that needs to be installed
and configured as a libModule as follows:
[gerrit]
installModule = com.googlesource.gerrit.owners.api.OwnersApiModule
Implementing the API for adding owners to attention-set is quite easy
and can be done also through scripting.
In Groovy it would be as easy as:
class MySelector implements OwnersAttentionSet {
Collection<Account.Id> addToAttentionSet
(ChangeInfo changeInfo,
Collection<Account.Id> owners) {
owners.take(2)
}
}
For existing owners-autoassign plugins, the injection of the
DynamicItem<OwnersAttentionSet> is optional and therefore is fully
transparent and all owners are added to the attention-set as per
Gerrit default mechanism.
Bug: Issue 14452
Change-Id: Ie2a6fbc289c66d99986bbaacb6ea4c9864515513
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.
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.
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.
This plugin is built with Bazel and two build modes are supported:
To build the plugin, issue the following command:
bazel build :all
The output is created in
bazel-bin/owners/owners.jar bazel-bin/owners-autoassign/owners-autoassign.jar
To execute the tests run:
bazel test //...
This project can be imported into the Eclipse IDE:
./tools/eclipse/project.sh
Create symbolic links of the owners and owners-autoassign folders and of the external_plugin_deps.bzl file to the Gerrit source code /plugins directory.
Create a symbolic link of the owners-common plugin to the Gerrit source code directory.
Then build the owners and owners-autoassign plugins with the usual Gerrit plugin compile command.
Example:
$ git clone https://gerrit.googlesource.com/plugins/owners $ git clone https://gerrit.googlesource.com/gerrit $ cd gerrit/plugins $ ln -s ../../owners/owners . $ ln -s ../../owners/owners-autoassign . $ ln -sf ../../owners/external_plugin_deps.bzl . $ cd .. $ ln -s ../owners/owners-common . $ bazel 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.
The output is created in
bazel-bin/plugins/owners/owners.jar bazel-bin/plugins/owners-autoassign/owners-autoassign.jar
To execute the tests run:
bazel test owners-common:test
This project can be imported into the Eclipse IDE:
Add the plugin name to the CUSTOM_PLUGINS in Gerrit core in tools/bzl/plugins.bzl file and run:
./tools/eclipse/project.py