Skip to content

Commit 33d319c

Browse files
Chore/improved error log (#165)
1 parent bb6b54d commit 33d319c

File tree

7 files changed

+221
-149
lines changed

7 files changed

+221
-149
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ There are several inputs available
161161
overwrite-comment: false # Overwrite existing Pull Request comment. Default is false
162162
always-latest-comment: false # Create a new comment if the existing comment is not the latest in the thread. Default is false
163163
comment-tag: false # Tag to match Pull Request comment
164-
write-ctrf-to-file: 'ctrf/ctrf-report.json' # Path to write the processed CTRF report for future processing. Default no write
164+
write-ctrf-to-file: 'ctrf/ctrf-report.json' # Path to write the internal processed CTRF report for future processing. Default no write
165165
upload-artifact: true # Upload to workflow artifact the processed CTRF report for future processing. Default false
166166
comment-tag: '' # Tag to match Pull Request comment
167167
@@ -410,9 +410,20 @@ You can generate human-readable AI report for your failed tests using models
410410
from the leading AI providers by using the AI Test Reporter integration or the
411411
[AI Test Reporter](https://github.com/ctrf-io/ai-test-reporter) directly.
412412

413-
## Run With NPX
413+
## Further Processing
414414

415-
You can run using `npx`, see full instructions here
415+
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.
416+
417+
This exposes the internal processed CTRF report that is enriched with properties used by the github test reporter.
418+
419+
```yaml
420+
- name: Write CTRF to File
421+
uses: ctrf-io/github-test-reporter@v1
422+
with:
423+
report-path: './ctrf/*.json'
424+
write-ctrf-to-file: './ctrf/ctrf-report.json'
425+
if: always()
426+
```
416427

417428
## What is CTRF?
418429

badges/coverage.svg

Lines changed: 1 addition & 1 deletion
Loading

dist/index.js

Lines changed: 78 additions & 50 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.

package-lock.json

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

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "github-actions-ctrf",
3-
"version": "0.0.59",
3+
"version": "1.0.17",
44
"description": "View test results directly within your GitHub workflow summary and Pull Requests",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)