@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Document the new "only if this didn't match last time" Herald action setting
Summary: Depends on D18930. Ref T13048. Try to explain what this does and give an example since I think it's probably not very obvious from the name.
Test Plan: Read the text.
Reviewers: amckinley
Reviewed By: amckinley
Maniphest Tasks: T13048
Differential Revision: https://secure.phabricator.com/D18931
+39
-1
+39
-1
src/docs/user/userguide/herald.diviner
+39
-1
src/docs/user/userguide/herald.diviner
···
20
20
21
21
> When [ all of ] these conditions are met:
22
22
> [ Title ][ contains ][ quasar ]
23
-
> Take these actions [ every time ] this rule matches:
23
+
> Take these actions [ every time this rule matches: ]
24
24
> [ Add me as a subscriber ]
25
25
26
26
This rule will automatically subscribe you to any newly created or updated
···
104
104
execute a dry run against that object, showing you which rules //would// match
105
105
had it actually been updated. Dry runs executed via the test console don't take
106
106
any actions.
107
+
108
+
109
+
Action Repetition Settings
110
+
==========================
111
+
112
+
Rules can be configured to act in different ways:
113
+
114
+
**Every time the rule matches:** The rule will take actions every time the
115
+
object is updated if the rule's conditions match the current object state.
116
+
117
+
**Only the first time the rule matches:** The rule will take actions only once
118
+
per object, regardless of how many times the object is updated. After the rule
119
+
acts once, it won't run on the same object again.
120
+
121
+
**If this rule did not match the last time:** This rule will take actions the
122
+
first time it matches for an object. After that, it won't act unless the object
123
+
just changed from not matching to matching.
124
+
125
+
For example, suppose you have a rule like this:
126
+
127
+
> When:
128
+
> [ Title ][ contains ][ duck ]
129
+
> Take actions [ if this rule did not match the last time: ]
130
+
> [ Add comment ][ "Please prefer the term 'budget goose'." ]
131
+
132
+
If you set this rule to act "every time", it will leave a comment on the task
133
+
for every single update until the title is edited. This is usually pretty noisy.
134
+
135
+
If you set this rule to act "only the first time", it will only leave one
136
+
comment. This fixes the noise problem, but creates a new problem: if someone
137
+
edits the title, then a later change breaks it again, the rule won't leave
138
+
another reminder comment.
139
+
140
+
If you set this rule to act "if it did not match the last time", it will leave
141
+
one comment on matching tasks. If the task is fixed (by replacing the term
142
+
"duck" with the term "budget goose", so the object no longer matches the rule)
143
+
and then later changed to violate the rule again (by putting the term
144
+
"duck" back in the title), the rule will act again.
107
145
108
146
109
147
Advanced Herald