Skip to content

Commit aebe14a

Browse files
committed
Update documentation and implement Tests Changed Report to track test additions and removals
1 parent 1bbb123 commit aebe14a

File tree

3 files changed

+41
-10
lines changed

3 files changed

+41
-10
lines changed

dist/reports/tests-changed-table.hbs

Lines changed: 0 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/report-showcase.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ execution.
77

88
- [Report Showcase](#report-showcase)
99
- [Summary Report](#summary-report)
10+
- [Summary Delta Report](#summary-delta-report)
1011
- [GitHub Report](#github-report)
1112
- [Test Report](#test-report)
1213
- [Test List Report](#test-list-report)
@@ -17,6 +18,7 @@ execution.
1718
- [Failed Folded Report](#failed-folded-report)
1819
- [Previous Results Report](#previous-results-report)
1920
- [Insights Report](#insights-report)
21+
- [Tests Changed Report](#tests-changed-report)
2022
- [Slowest Report](#slowest-report)
2123
- [AI Report](#ai-report)
2224
- [Skipped Report](#skipped-report)
@@ -80,8 +82,6 @@ Set the `summary-delta-report` input to true in your workflow configuration:
8082
| --- | --- | --- | --- | --- | --- | --- |
8183
| **58**    *↑2* | **58**    *±0* | **0**    *±0* | **0**    *±0* | **0**    *±0* | **0**    *±0* | **11.2s**    *↓2ms* |
8284

83-
84-
8585
## File Report
8686

8787
### Overview
@@ -711,6 +711,45 @@ Set the `insights-report` input to true in your workflow configuration:
711711

712712
<sub><i>Measured over 2 runs.</i></sub>
713713

714+
## Tests Changed Report
715+
716+
### Overview
717+
718+
Displays tests that have been added or removed compared to a baseline or previous run. This report helps track test suite evolution over time by showing exactly which tests are new and which have been removed. Each test is listed with its name and suite hierarchy, making it easy to identify changes in your test coverage.
719+
720+
Requires previous test results or a baseline for comparison.
721+
722+
### Usage
723+
724+
Set the `tests-changed-report` input to true in your workflow configuration:
725+
726+
```yaml
727+
- name: Publish Test Report
728+
uses: ctrf-io/github-test-reporter@v1
729+
with:
730+
report-path: './ctrf/*.json'
731+
tests-changed-report: true
732+
if: always()
733+
```
734+
735+
---
736+
737+
**3 new tests added, 1 removed**
738+
739+
### Added ➕
740+
741+
| **Name** | **Suite** |
742+
| --- | --- |
743+
| should handle async operations correctly | API Tests > Authentication |
744+
| should validate user input | API Tests > Validation |
745+
| should cache results properly | Performance Tests |
746+
747+
### Removed ➖
748+
749+
| **Name** | **Suite** |
750+
| --- | --- |
751+
| deprecated legacy test | Legacy Suite > Old Tests |
752+
714753
## Slowest Report
715754

716755
### Overview

src/reports/tests-changed-table.hbs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
{{#if (and report.insights.extra.testsAdded report.insights.extra.testsRemoved)}}
21
{{#if (or (gt report.insights.extra.testsAdded.length 0) (gt report.insights.extra.testsRemoved.length 0))}}
32
**{{report.insights.extra.testsAdded.length}} new test{{#if (gt report.insights.extra.testsAdded.length 1)}}s{{/if}} added, {{report.insights.extra.testsRemoved.length}} removed**
43

@@ -24,7 +23,4 @@
2423
{{else}}
2524
No changes to tests detected ✨
2625
{{/if}}
27-
{{else}}
28-
No changes to tests detected ✨
29-
{{/if}}
3026

0 commit comments

Comments
 (0)