Clarify instructions for "Process this rule at most (times)" #149
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #149 +/- ##
============================================
+ Coverage 99.13% 99.21% +0.08%
- Complexity 124 135 +11
============================================
Files 27 29 +2
Lines 231 256 +25
Branches 17 18 +1
============================================
+ Hits 229 254 +25
Misses 1 1
Partials 1 1 ☔ View full report in Codecov by Sentry. |
| @@ -2,12 +2,23 @@ | |||
| <p>The rule will stop being processed after a certain number of matched builds. | |||
| Once this condition is met, only the other rules will continue to be processed.</p> | |||
|
|
|||
| <p><b>Use cases</b></p> | |||
| <p>This feature provides the option to control the number of builds the rule can process. It may save a significant amount of time when the build history is long.</p> | |||
| <p>Internally and in the documentation, this value is called <code>matchAtMost</code>.</p> | |||
There was a problem hiding this comment.
from the user perspective this is valuable how to use/configure and not how this is named internally
| <li>If <code>matchAtMost = -1</code>, there is no limitation; all builds will be evaluated.</li> | ||
| <li>If <code>matchAtMost = 0</code>, no builds will be evaluated. This disables the rule, as it will not apply to any build.</li> | ||
| <li>If <code>matchAtMost > 0</code>, this rule will only be applied <code>matchAtMost</code> times | ||
| in each build history manager process (in each loop over builds after a build).</li> |
There was a problem hiding this comment.
build history manager process -> plugin, if I understand correctly meaning
There was a problem hiding this comment.
I meant the process the plugin follows after each build. Haven't looked much in the code but I guess there is some function that is executed as a hook/event from Jenkins. That function has some algorithm (process).
|
|
||
| <p><b>Use cases</b></p> | ||
| <p>This feature provides the option to control the number of builds the rule can process. | ||
| If used with specific actions it can save a significant amount of time when the build history is long.</p> |
There was a problem hiding this comment.
this suggests that the option has only performance impact while the better performance is only side effect - the real purpose of this flag is to make sure that action is executed at mostn times
There was a problem hiding this comment.
Hm... This was the original use case actually :-)
| <p>This feature provides the option to control the number of builds the rule can process. | ||
| If used with specific actions it can save a significant amount of time when the build history is long.</p> | ||
|
|
||
| <p>This feature also provides the option to skip a number of builds while processing builds. |
There was a problem hiding this comment.
not also - this is the only feature
There was a problem hiding this comment.
I think the original use case is still valid. You can use matchAtMost to skip tail (and maybe save some time) and you can also use it to skip head (and preserve top builds).
Form-doc update as described in issue #148.
Testing done
Checked with xhtml validator: https://validator.w3.org/check
Submitter checklist
Link to relevant pull requests, esp. upstream and downstream changesEnsure you have provided tests - that demonstrates feature works or fixes the issue