| commit | 7885af5756ae817bf3fc5d0ed140d8de6148251a | [log] [tgz] |
|---|---|---|
| author | Edwin Kempin <ekempin@google.com> | Wed Jan 31 09:19:26 2024 +0000 |
| committer | Edwin Kempin <ekempin@google.com> | Wed Jan 31 09:19:26 2024 +0000 |
| tree | cbb734bf41cdfc398c11f21e77956daa389404d2 | |
| parent | d255cc6a521553ad2c67f5467bcd66d4b078132e [diff] |
Update documentation about how to run the tests The currently documented command bazel test --test_tag_filters=checks neithers works when running it from the gerrit root dir nor when running it from the checks plugin dir. The new command bazel test //plugins/checks/... works from the gerrit root dir and is the same command that is also used for running the tests of other plugins (e.g. the tests for the code-owners plugin are run by "bazel test //plugins/code-owners/..."). Change-Id: I50e2250872a4d01142d4ce0a4b645d7928ffbc48 Signed-off-by: Edwin Kempin <ekempin@google.com>
The Gerrit team at Google has decided to discontinue work on the checks plugin. The recommended solution is [https://gerrit-review.googlesource.com/Documentation/pg-plugin-checks-api.html](Checks UI) which surfaces results from an external CI/analysis system.
This plugin provides a unified experience for checkers (CI systems, static analyzers, etc.) to integrate with Gerrit Code Review.
When upgrading the plugin, please use init:
java -jar gerrit.war init -d site_path
More details about “init” in https://gerrit-review.googlesource.com/Documentation/pgm-init.html
To enable sending email notifications for “checks” status updates, you'll need to create the email templates in <your-site-path>/etc/mail. In the simplest form, simply rename the example templates:
cd "<your-site-path>"
mv etc/mail/CombinedCheckStateUpdated.soy{.example,}
mv etc/mail/CombinedCheckStateUpdatedHtml.soy{.example,}
For running unit tests execute:
bazel test --test_output=all //plugins/checks/web:karma_test
For checking or fixing eslint formatter problems run:
bazel test //plugins/checks/web:lint_test bazel run //plugins/checks/web:lint_bin -- --fix "$(pwd)/plugins/checks/web"
For testing the plugin with Gerrit FE Dev Helper build the JavaScript bundle and copy it to the plugins/ folder:
bazel build //plugins/checks/web:checks cp -f bazel-bin/plugins/checks/web/checks.js plugins/
and let the Dev Helper redirect from .+/plugins/checks/static/checks.js to http://localhost:8081/plugins_/checks.js.