Phabricator Administrator's Handbook/Herald
Jump to navigation
Jump to search
![](//upload.wikimedia.org/wikipedia/commons/thumb/1/11/Phabricator_Herald_Rule_creation.png/220px-Phabricator_Herald_Rule_creation.png)
All the available Herald Rule types
![](//upload.wikimedia.org/wikipedia/commons/thumb/a/a5/Phabricator_Herald_rule_type_Object_run_Build_Plan_on_commit.png/220px-Phabricator_Herald_rule_type_Object_run_Build_Plan_on_commit.png)
Herald rule created to run a Build Plan after every commit.
![](http://upload.wikimedia.org/wikipedia/commons/thumb/1/11/Phabricator_Herald_Rule_creation.png/220px-Phabricator_Herald_Rule_creation.png)
![](http://upload.wikimedia.org/wikipedia/commons/thumb/a/a5/Phabricator_Herald_rule_type_Object_run_Build_Plan_on_commit.png/220px-Phabricator_Herald_rule_type_Object_run_Build_Plan_on_commit.png)
Herald is a Phabricator component designed to trigger actions if some rules are matched.[1]
Read the Herald Official Documentation to learn some basic characteristics.
Here some frequently asked behaviors.
Block a commit
[edit | edit source]Herald can be configured to block a commit before reaching your repository. For example it be useful to:
- avoid to accidentally disclosure sensitive data (SSH private keys, API tokens, etc. you know)
- avoid to accidentally version binary files (
.war
,.apk
) - respect some policies, like blocking short commit messages[2]
Herald types suitable for this kind of rules:
Commit Hook: Commit Content
: can react on commit message and contents etc.Commit Hook: Branches/Tags/Bookmarks
: for other cases, the origin of the request etc.
Run a Build Plan
[edit | edit source]See also
[edit | edit source]Notes
[edit | edit source]- ↑ The Herald component can be found searching Herald in the Phabricator search box or visiting
example.com/herald/
. - ↑ "Block short commit message with Herald regex". Phabricator Discussion forum.