Skip to content

Commit d5849b3

Browse files
committed
minor changes
1 parent b76357a commit d5849b3

File tree

6 files changed

+170
-140
lines changed

6 files changed

+170
-140
lines changed

.github/workflows/build-and-test.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ jobs:
5252
uses: ./
5353
with:
5454
report-path: './ctrf/*.json'
55-
pull-request-report: true
55+
ai-summary-report: true
56+
pull-request: true
5657
annotate: false
5758
env:
5859
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@ You can support the project by:
1919
- Giving this repository a ⭐
2020
- [Following the @ctrf organization on GitHub](https://github.com/ctrf-io)
2121

22-
## Example
23-
24-
<div align="center">
25-
<img src="images/github-readme.png" alt="GitHub Test Reporter" width="600">
26-
</div>
27-
2822
## Key Features
2923

3024
**🧩 Post anywhere:** job summaries, pull requests, checks, issues, inline annotations, and other developer tools
@@ -43,7 +37,7 @@ You can support the project by:
4337
2. [Report Showcase](#report-showcase)
4438
3. [Visual Overview](#visual-overview)
4539
4. [Available Inputs](#available-inputs)
46-
5. [Generating an AI Report](#generating-an-ai-report)
40+
5. [Continuous AI](#continuous-ai)
4741
6. [Pull Requests](#pull-requests)
4842
7. [Status Checks](#status-checks)
4943
8. [Build Your Own Report](#build-your-own-report)
@@ -68,6 +62,10 @@ To get started add the following to your workflow file:
6862
if: always()
6963
```
7064
65+
<div align="center">
66+
<img src="images/github-readme.png" alt="GitHub Test Reporter" width="600">
67+
</div>
68+
7169
## Report Showcase
7270
7371
Checkout the [built-in reports](docs/report-showcase.md)
@@ -163,7 +161,7 @@ For more advanced usage, there are several inputs available.
163161
164162
Only `report-path` is required.
165163

166-
## Generating an AI Report
164+
## Continuous AI
167165

168166
You can generate human-readable AI reports for your failed tests using models
169167
from the leading AI providers. The GitHub Test Reporter now features dedicated
@@ -179,15 +177,15 @@ with the provider and any optional settings:
179177
uses: ctrf-io/github-test-reporter@v1
180178
with:
181179
report-path: './ctrf/*.json'
182-
github-report: true
180+
ai-summary-report: true
181+
pull-request: true
183182
ai: |
184183
{
185184
"provider": "openai",
186-
"model": "gpt-4",
187-
"temperature": 0.7,
188-
"maxTokens": 2000
185+
"model": "gpt-4"
189186
}
190187
env:
188+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
191189
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
192190
if: always()
193191
```
@@ -223,30 +221,13 @@ All configuration parameters are specified at the root level (all optional excep
223221
"topP": 1, // Nucleus sampling
224222
"maxMessages": 10, // Max failed tests to analyze
225223
"consolidate": true, // Consolidate multiple failures
224+
"additionalPromptContext": "...", // Additional prompt context
225+
"additionalSystemPromptContext": "...", // Additional system prompt context
226226
"log": false, // Enable logging
227227
"deploymentId": "..." // Azure OpenAI deployment ID (Azure only)
228228
}
229229
```
230230

231-
### Example with Claude
232-
233-
```yaml
234-
- name: Publish Test Report with Claude AI
235-
uses: ctrf-io/github-test-reporter@v1
236-
with:
237-
report-path: './ctrf/*.json'
238-
github-report: true
239-
ai: |
240-
{
241-
"provider": "claude",
242-
"model": "claude-3-5-sonnet-20241022",
243-
"maxTokens": 3000
244-
}
245-
env:
246-
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
247-
if: always()
248-
```
249-
250231
## Pull Requests
251232

252233
You can add a pull request comment by using the `pull-request-report` input:

dist/index.js

Lines changed: 1 addition & 21 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)