Phabricator/Help/Herald Rules

From MediaWiki.org
Jump to navigation Jump to search

Please note that global Herald rules are expensive and impact Phabricator performance (see phab:T108586) and can often be avoided by using more appropriate tools:

  • Instead of "Add also project Foo when project Bar is associated" type rules, consider using subprojects and milestones.
  • Instead of "Subscribe me to task if it is associated with Foo project" type rules, watch the project.
  • Instead of "Add my user project when I subscribe to a task" type rules, create a dashboard which includes a panel that displays the query of tasks you are subscribed to.
  • Phabricator admins might delete inappropriate or expensive Herald rules and will inform the Herald rule author about this action.

 Creating Herald rules for notifications[edit]

This is how you create custom (personal) notification rules in Wikimedia Phabricator's Herald. Imagine you want to watch all the tasks that are being created:

  1. Click Create Herald Rule.
  2. Select Maniphest Tasks and Personal.
  3. Give a descriptive name to the rule, i.e. "All New Tasks".
  4. In Conditions, select all of, Is newly created?, and is True.
  5. In Action, select every time and Send me an email.
  6. Save Rule.

This is it. From that point, you will receive an email for every task being created. This is probably too much, though. This is how you can filter these notifications:

  • If you want to be notified about new tasks only in specific projects, add a New Condition, and then select Projects and include any of, adding the projects you are interested about.
  • If you want to be notified about new tasks only from specific users, add a New Condition, and then select Author and is any of, adding the users you are interested about.

You see where is this going. Adapting these rules you can watch the entire activity of a specific project without having to join it, you can watch certain keywords across the entire Phabricator, etc.

Global Herald rules[edit]

To create global Herald rules (rules unrelated to your personal account, like adding a project to a task when another project is added), create a task in Phabricator describing your request. If the request is not completed within a reasonable amount of time, contact one of the Phabricator admins (preferably User:AKlapper (WMF)).

Available global Herald options in Maniphest