| commit | 2483bbf272f423280f62fe4949092aebf9a1b682 | [log] [tgz] |
|---|---|---|
| author | Wade Carpenter <wade@arista.com> | Tue Aug 24 19:09:54 2021 -0700 |
| committer | Wade Carpenter <wade@arista.com> | Mon Oct 18 07:49:22 2021 -0700 |
| tree | cd4b636a6cfb38d0f610ec4cbd9e54c7fffbd99c | |
| parent | aa7785aa3ba6ac244bc31cc255a48bac4e1379c0 [diff] |
Add "Enable e-mail notifications" section to README.md After installing the checks plugin, I noticed that I wasn't getting e-mail notifications. I had followed the `init` instructions, but still was having errors about a missing CombinedCheckStateUpdated.soy resource. I discovered that the init code appears to only create CombinedCheckStateUpdated.soy.example, and so the CombinedCheckStateUpdated.soy file is not present in etc/mail. Updated README.md to give this hint to users when setting up the plugin. Change-Id: I2f43cf62d938331776f444743f234952300eb3e2
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.