Skip to content

Commit 9b31378

Browse files
committed
docs: add insights and slowest tests reports to documentation
1 parent d40789b commit 9b31378

File tree

1 file changed

+93
-1
lines changed

1 file changed

+93
-1
lines changed

docs/report-showcase.md

Lines changed: 93 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ execution.
1515
- [Flaky Rate Report](#flaky-rate-report)
1616
- [Failed Folded Report](#failed-folded-report)
1717
- [Previous Results Report](#previous-results-report)
18+
- [Insights Report](#insights-report)
19+
- [Slowest Report](#slowest-report)
1820
- [AI Report](#ai-report)
1921
- [Skipped Report](#skipped-report)
2022
- [Suite Folded Report](#suite-folded-report)
@@ -203,6 +205,10 @@ enabling teams to prioritize fixes and improve overall test reliability.
203205
Use the `previous-results-max` input to state how many previous results to
204206
include in the calculation. The default is 10.
205207

208+
This report goes nicely with the insights-report, flaky-rate-report, and
209+
slowest-report to provide a comprehensive view of the performance of your tests
210+
over time.
211+
206212
Test case fail rate is calculated by dividing the fail count by the total runs
207213
and multiplying by 100:
208214

@@ -290,6 +296,10 @@ flaky tests within CTRF.
290296
Use the `previous-results-max` input to state how many previous results to
291297
include in the calculation. The default is 10.
292298

299+
This report goes fits nicely with the insights-report, fail-rate-report, and
300+
slowest-report to provide a comprehensive view of the performance of your tests
301+
over time.
302+
293303
Test flaky rate (%) is calculated by dividing the number of flaky occurrences by
294304
the total number of test attempts (including retries) and multiplying by 100:
295305

@@ -415,6 +425,9 @@ developers to track trends in test outcomes over time and identify patterns or
415425
recurring issues. This insight helps teams monitor the stability of their test
416426
suite and prioritize areas for improvement based on historical performance.
417427

428+
Use the `previous-results-max` input to state how many previous results to
429+
include in the calculation. The default is 10.
430+
418431
### Usage
419432

420433
Set the `previous-results-report` input to true in your workflow configuration:
@@ -440,10 +453,89 @@ Set the `previous-results-report` input to true in your workflow configuration:
440453
| [#2](https://github.com/Ma11hewThomas/github-test-reporter-test/actions/runs/12817830233) | ❌ | 10 | 5 | 3 | 1 | 1 | 1 | 3 | 11.0s |
441454
| [#1](https://github.com/Ma11hewThomas/github-test-reporter-test/actions/runs/12817798111) | ❌ | 10 | 5 | 3 | 1 | 1 | 1 | 3 | 11.0s |
442455

443-
## AI Report
456+
## Insights Report
457+
458+
### Overview
459+
460+
Provides insights about the latest builds. This report includes key metrics
461+
includes key metrics average tests per run, total flaky tests, total failed, and
462+
slowest test (p95). It helps teams to optimise their test suite and improve the
463+
overall test reliability.
464+
465+
Use the `previous-results-max` input to state how many previous results to
466+
include in the calculation. The default is 10.
467+
468+
This report goes fits nicely with the flaky-rate-report,
469+
fail-rate-report, and slowest-report to provide a comprehensive view of the performance of your test suite overtime.
470+
471+
### Usage
472+
473+
Set the `insights-report` input to true in your workflow configuration:
474+
475+
```yaml
476+
- name: Publish Test Report
477+
uses: ctrf-io/github-test-reporter@v1
478+
with:
479+
report-path: './ctrf/*.json'
480+
insights-report: true
481+
if: always()
482+
```
483+
484+
---
485+
486+
| Average Tests per Run | Total Flaky Tests | Total Failed | Slowest Test (p95) |
487+
|----------------------|-------------------|----------------|-------------------|
488+
| 17 | 0 | 0 | 12ms |
489+
490+
<sub><i>Measured over 2 runs.</i></sub>
491+
492+
## Slowest Report
444493

445494
### Overview
446495

496+
Provides a detailed view of the slowest tests from the current and previous results. This report
497+
includes the test name, number of runs, number of failures, failure rate, and
498+
average duration. It helps teams identify and address performance issues in their
499+
test suite.
500+
501+
Use the `previous-results-max` input to state how many previous results to
502+
include in the calculation. The default is 10.
503+
504+
This report fits nicely with the insights-report, fail-rate-report, and
505+
flaky-rate-report to provide a comprehensive view of the performance of your tests
506+
over time.
507+
508+
### Usage
509+
510+
Set the `slowest-report` input to true in your workflow configuration:
511+
512+
```yaml
513+
- name: Publish Test Report
514+
uses: ctrf-io/github-test-reporter@v1
515+
with:
516+
report-path: './ctrf/*.json'
517+
slowest-report: true
518+
if: always()
519+
```
520+
521+
---
522+
523+
### Slowest Tests
524+
525+
| Test 📝 | Runs 🎯 | Fail ❌ | Fail Rate % | Average Duration (p95) ⏱️ |
526+
|-----------|-----------------|------------|----------|-----------|
527+
| helpers.test.ts &gt; stripAnsi - stripAnsi throws a TypeError if the input is not a string | 1 | 0 | 0% | 12ms |
528+
| handler.test.ts &gt; createStatusCheck - createStatusCheck should create a successful check run when no tests failed | 1 | 0 | 0% | 5ms |
529+
| helpers.test.ts &gt; getEmoji - getEmoji returns the correct emoji for &quot;passed&quot; | 1 | 0 | 0% | 4ms |
530+
| helpers.test.ts &gt; getEmoji - getEmoji returns the correct emoji for &quot;duration&quot; | 1 | 0 | 0% | 1ms |
531+
| helpers.test.ts &gt; getEmoji - getEmoji returns the correct emoji for &quot;tests&quot; | 1 | 0 | 0% | 1ms |
532+
| helpers.test.ts &gt; stripAnsi - stripAnsi removes ANSI escape codes from a string | 1 | 0 | 0% | 1ms |
533+
| handler.test.ts &gt; createStatusCheck - createStatusCheck should truncate summary if it exceeds 65000 characters | 1 | 0 | 0% | 1ms |
534+
535+
<sub><i>Measured over 2 runs.</i></sub>
536+
537+
## AI Report
538+
447539
Leverages AI-generated insights to provide detailed summaries for failed tests.
448540
For each failure, the report includes an AI-powered explanation of potential
449541
causes and suggested solutions to help developers quickly identify and resolve

0 commit comments

Comments
 (0)