You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To get started quickly add the following to your workflow file:
61
59
62
60
```yaml
63
61
- name: Publish Test Report
@@ -68,15 +66,106 @@ To get started add the following to your workflow file:
68
66
if: always()
69
67
```
70
68
71
-
## Report Showcase
69
+
Add `upload-artifact: true`, `fetch-previous-results: true` and a `GITHUB_TOKEN` to enable comparisons.
70
+
71
+
<div align="center">
72
+
<img src="images/github.png" alt="GitHub Test Reporter" width="600">
73
+
</div>
74
+
75
+
## Insights Usage
76
+
77
+
To get started with multi run insights on failures, flakiness and test duration, add the following to your workflow file:
78
+
79
+
```yaml
80
+
- name: Publish Test Report with Insights
81
+
uses: ctrf-io/github-test-reporter@v1
82
+
with:
83
+
report-path: './ctrf/*.json'
84
+
summary-delta-report: true
85
+
insights-report: true
86
+
flaky-rate-report: true
87
+
fail-rate-report: true
88
+
slowest-report: true
89
+
upload-artifact: true
90
+
env:
91
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
92
+
if: always()
93
+
```
94
+
95
+
This will create a job summary with insights on failures, flakiness and test duration.
96
+
97
+
<div align="center">
98
+
<img src="images/insights.png" alt="GitHub Test Reporter" width="600">
99
+
</div>
100
+
101
+
## Continuous AI Usage
102
+
103
+
To get started with continuous AI analysis of test results, add the following to your workflow file:
104
+
105
+
```yaml
106
+
- name: Publish Test Report with AI Analysis
107
+
uses: ctrf-io/github-test-reporter@v1
108
+
with:
109
+
report-path: './ctrf/*.json'
110
+
ai-summary-report: true
111
+
on-fail-only: true
112
+
summary: false
113
+
pull-request: true
114
+
ai: |
115
+
{
116
+
"provider": "openai",
117
+
"model": "gpt-5"
118
+
}
119
+
if: always()
120
+
env:
121
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
122
+
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
123
+
```
124
+
125
+
Add your AI API key to the repository secrets. Choose from a variety of AI providers and models. See [AI Configuration](#ai-configuration) for more information.
126
+
127
+
Make sure your GitHub Token has pull request write permission.
72
128
73
-
Checkout the [built-in reports](docs/report-showcase.md)
129
+
This will create a pull request comment with a summary of the AI analysis.
74
130
75
-
## Visual Overview
131
+
<div align="center">
132
+
<img src="images/ai-summary.png" alt="GitHub Test Reporter" width="600">
To get started with pull request comments, add the following to your workflow file:
138
+
139
+
```yaml
140
+
- name: Publish Test Report with Pull Request Comment
141
+
uses: ctrf-io/github-test-reporter@v1
142
+
with:
143
+
report-path: './ctrf/*.json'
144
+
pull-request-report: true
145
+
if: always()
146
+
env:
147
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
148
+
```
149
+
150
+
Make sure your GitHub Token has pull request write permission.
151
+
152
+
This will create a pull request comment with a summary of the test results.
153
+
154
+
<div align="center">
155
+
<img src="images/pr-comment.png" alt="GitHub Test Reporter" width="600">
156
+
</div>
157
+
158
+
<div align="center">
159
+
<img src="images/pr-comment-with-fail.png" alt="GitHub Test Reporter" width="600">
160
+
</div>
161
+
162
+
## Super Flexible Usage
163
+
164
+
These are just a few examples of the many ways the GitHub Test Reporter can be used. It is super flexible and can be used in a variety of ways. Continue reading to learn more about the many features and options available.
165
+
166
+
## Report Showcase
167
+
168
+
There are a variety of built-in reports to choose from. Checkout the [built-in reports](docs/report-showcase.md)
80
169
81
170
## Generate a report
82
171
@@ -86,6 +175,8 @@ This reporter works best with CTRF as it's packed with modern properties. [CTRF
86
175
87
176
For more details on using JUnit, see [JUnit integration instructions](docs/integrations.md#junit-to-ctrf-integration)
88
177
178
+
Don't see a reporter for your testing framework? Consider contributing 💚
179
+
89
180
## Available Inputs
90
181
91
182
For more advanced usage, there are several inputs available.
@@ -207,6 +298,7 @@ The following AI providers are supported:
207
298
- **perplexity** - Perplexity AI
208
299
- **openrouter** - OpenRouter (access to multiple models)
@@ -463,8 +556,6 @@ For detailed information about configuring and using these integrations, see our
463
556
464
557
Integrations are currently in beta. Please report any issues to the [GitHub Test Reporter repository](https://github.com/ctrf-io/github-test-reporter/issues).
465
558
466
-
467
-
468
559
## Further Processing
469
560
470
561
You can further process the CTRF report by using the output `report` from the action or by using the `write-ctrf-to-file` input. For reports larger than 1MB, consider using the `write-ctrf-to-file` input.
0 commit comments