| commit | ff81a80f14954bb2746e0671eab3bba43148d4a7 | [log] [tgz] |
|---|---|---|
| author | Edwin Kempin <ekempin@google.com> | Wed Feb 14 12:16:44 2024 +0000 |
| committer | Edwin Kempin <ekempin@google.com> | Wed Feb 14 12:51:11 2024 +0000 |
| tree | a8788b4a10ed494648d85b1365213d7c074b4543 | |
| parent | 72206edcf94db694c8830c75e1e9583fe6916ee1 [diff] |
Explain on the about page when the code-owners plugin should/shouldn't be used This is already explained in the how to use guide, but users often miss this information there. The about page is the entry page of the code-owners documentation (it is integrated as the first section into the index page) and what users that are interested in using the code-owners plugin read first, hence users are unlikely to miss this information here. Change-Id: Ie3800fd96eadcbcaa97f610398f911b4a1db25b3 Signed-off-by: Edwin Kempin <ekempin@google.com> Reviewed-on: https://gerrit-review.googlesource.com/c/plugins/code-owners/+/409498 Tested-by: Zuul <zuul-63@gerritcodereview-ci.iam.gserviceaccount.com> Reviewed-by: Nitzan Gur-Furman <nitzan@google.com>
This plugin provides support for defining code owners for files in a repository.
If the code-owners plugin is enabled, changes can only be submitted if all touched files are covered by approvals from code owners.
For a detailed description of the plugin functionality please refer to the plugin documentation.
IMPORTANT: Before installing/enabling the plugin follow the instructions from the setup guide.
NOTE: The plugin documentation only renders correctly when the plugin is installed in Gerrit and the documentation is accessed via https:///plugins/code-owners/Documentation/index.html. If you want to read the documentation before installing the plugin, you can find it properly rendered here.
From the root of the gerrit repository.
bazel test //plugins/code-owners/web:karma_test
For testing the plugin with the Gerrit FE Dev Helper the command below builds
bazel build //plugins/code-owners/web:code-owners
ln -s bazel-bin/plugins/code-owners/web/code-owners.js polygerrit-ui/app/plugins/
and let the Dev Helper redirect from .+/plugins/code-owners/static/code-owners.js to http://localhost:8081/plugins/code-owners.js.