Skip to content

Commit 3400238

Browse files
update documentation for advanced threshold policies (via #396)
1 parent d243506 commit 3400238

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,31 @@ This plugin allows you to create Allure reports as part of your Jenkins builds.
2020

2121
To learn more, please visit [the official documentation](https://allurereport.org/docs/integrations-jenkins/).
2222

23+
### Advanced Threshold Policies
24+
25+
Overview
26+
- The plugin can now assess build stability using:
27+
- Percentage-based thresholds
28+
- Absolute failure-count thresholds
29+
- Aggregated evaluation in matrix builds
30+
- Optional preservation of the original Jenkins build result
31+
32+
This functionality is fully backward-compatible. Existing pipelines continue to operate without modification unless new parameters are explicitly provided.
33+
34+
### Parameters
35+
| Parameter | Description |
36+
|---------------------------------|-------------------------------------------------------------------------|
37+
| `unstableThresholdPercent` | Marks build **UNSTABLE** if % of failed tests ≥ threshold |
38+
| `failureThresholdPercent` | Marks build **FAILURE** if % of failed tests ≥ threshold |
39+
| `failureThresholdCount` | Marks build **FAILURE** if number of failed tests ≥ threshold |
40+
| `resultPolicy` (`DEFAULT`, `LEAVE_AS_IS`) | Controls whether Allure modifies the final build result |
41+
| `results` | Supports glob patterns for multi-axis builds (e.g., `**/allure-results`) |
42+
43+
Compatibility Notes
44+
- If no threshold parameters are provided, the plugin uses its original behavior.
45+
- Thresholds apply only when Allure results are present and successfully generated.
46+
- This feature does not alter the reporting format or Allure commandline behavior.
47+
2348
## Useful links
2449

2550
* [Issues](https://github.com/jenkinsci/allure-plugin/issues?labels=&milestone=&page=1&state=open)

0 commit comments

Comments
 (0)