Skip to content

Commit b257348

Browse files
committed
Add baseline report options for metrics comparison in README
1 parent 621e169 commit b257348

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ For more advanced usage, there are several inputs available.
170170
fetch-previous-results: false # Always fetch previous workflow runs when using custom templates. Default is false
171171
max-workflow-runs-to-check: 400 # Maximum number of workflow runs to check for previous results. Default is 400
172172
max-previous-runs-to-fetch: 100 # Maximum number of previous runs to fetch and process for metrics and reports. Default is 100
173+
baseline: 1 # Baseline report to use for metrics comparison. Number = previous n reports, string = reportId.' Default is 1 (last run)
174+
baseline-report-path: 'path/to/baseline/report.json' # Path to a specific CTRF report to use as a baseline.'
173175
group-by: 'filePath' # Specify grouping for applicable reports (e.g., suite or file path). Default is filePath
174176
always-group-by: false # Force grouping by suite or file path for all reports. Default is false
175177
report-order: 'summary-report,failed-report,flaky-report,skipped-report,test-report' # Comma-separated list of report types to specify the order in which reports should be displayed
@@ -390,6 +392,14 @@ previous results as follows:
390392
This ensures that you only see workflow runs that are related to your current
391393
branch or pull request
392394

395+
## Baseline Reports
396+
397+
You can specify a baseline report to use for delta and metrics comparison using the `baseline` or `baseline-report-path` inputs.
398+
399+
- `baseline`: Specify a baseline report by providing either a number (e.g., 1 for the last run, 2 for the run before that) or a string representing the report ID. This allows you to compare your current test results against a specific previous run. The default value is 1, which uses the most recent previous report as the baseline.
400+
401+
- `baseline-report-path`: Provide a path to a specific CTRF report file to use as the baseline for comparison. This is useful if you want to compare against a particular report that is on the filesystem.
402+
393403
## Integrations
394404

395405
CTRF tooling offers seamless developer tool integration, allowing you to combine the GitHub Test Reporter with the following tools:

0 commit comments

Comments
 (0)