Changeset View
Changeset View
Standalone View
Standalone View
src/docs/user/userguide/herald.diviner
@title Herald User Guide | @title Herald User Guide | ||||
@group userguide | @group userguide | ||||
Use Herald to get notified of changes you care about. | Use Herald to get notified of changes you care about. | ||||
Overview | Overview | ||||
======== | ======== | ||||
Herald allows you to write rules which run automatically when objects (like | Herald allows you to write rules which run automatically when objects (like | ||||
tasks or commits) are created or updated. For instance, you might want to get | tasks or commits) are created or updated. For instance, you might want to get | ||||
notified every time someone sends out a revision that affects some file you're | notified every time someone sends out a revision that affects some file you're | ||||
interested in, even if they didn't add you as a reviewer. | interested in, even if they didn't add you as a reviewer. | ||||
One way to think about Herald is that it is a lot like the mail rules you can | One way to think about Herald is that it is a lot like the mail rules you can | ||||
set up in most email clients to organize mail based on "To", "Subject", etc. | set up in most email clients to organize mail based on "To", "Subject", etc. | ||||
Herald works very similarly, but operates on Phabricator objects (like revisions | Herald works very similarly, but operates on Phorge objects (like revisions | ||||
and commits) instead of emails. | and commits) instead of emails. | ||||
For example, you can write a personal rule like this which triggers on tasks: | For example, you can write a personal rule like this which triggers on tasks: | ||||
> When [ all of ] these conditions are met: | > When [ all of ] these conditions are met: | ||||
> [ Title ][ contains ][ quasar ] | > [ Title ][ contains ][ quasar ] | ||||
> Take these actions [ every time this rule matches: ] | > Take these actions [ every time this rule matches: ] | ||||
> [ Add me as a subscriber ] | > [ Add me as a subscriber ] | ||||
▲ Show 20 Lines • Show All 154 Lines • Show Last 20 Lines |
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under Apache 2.0 or other open source licenses. · CC BY-SA 4.0 · Apache 2.0