diff --git a/src/main/resources/pl/damianszczepanik/jenkins/buildhistorymanager/model/Rule/help-matchAtMost.html b/src/main/resources/pl/damianszczepanik/jenkins/buildhistorymanager/model/Rule/help-matchAtMost.html index 05965b69..a0e740b1 100644 --- a/src/main/resources/pl/damianszczepanik/jenkins/buildhistorymanager/model/Rule/help-matchAtMost.html +++ b/src/main/resources/pl/damianszczepanik/jenkins/buildhistorymanager/model/Rule/help-matchAtMost.html @@ -2,12 +2,23 @@
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.
-Use cases
-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.
+Internally and in the documentation, this value is called matchAtMost
.
There are some special values:
-1
, there is no limitation, all builds will be evaluated.0
, no builds will be evaluated. This disables the rule as it will not apply to any build.1..n
, once the value is reached, the rule is effectively disabled and is no longer applied.matchAtMost = -1
, there is no limitation; all builds will be evaluated.matchAtMost = 0
, no builds will be evaluated. This disables the rule, as it will not apply to any build.matchAtMost > 0
, this rule will only be applied matchAtMost
times
+ in each build history manager process (in each loop over builds after a build).Use cases
+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.
+ +This feature also provides the option to skip a number of builds while processing builds.
+ To skip 5 builds, you should create a rule with the "Match every build" condition and no action, then set matchAtMost = 5
.
+ This will effectively skip 5 builds in each build history manager process. It’s equivalent to saying buildToCheck = lastBuildNo - 5
.
Warning!
If the matchAtMost
value is set to zero, the rule is effectively disabled. This is useful if the user wants to disable a rule while keeping its other configuration values.