Skip to content

Commit

Permalink
docs: convert ctrf
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Jun 14, 2024
1 parent a665300 commit 31a867a
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,17 @@ npx github-actions-ctrf path-to-your-ctrf-report.json

Before using the commands, ensure that your GitHub Actions runner has Node.js installed.

You'll need a CTRF report generated by your testing framework. [CTRF reporters](https://www.ctrf.io/docs/category/reporters) are available for most testing frameworks and easy to install.
Generate a CTRF report using your testing framework. [CTRF reporters](https://www.ctrf.io/docs/category/reporters) are available for most testing frameworks and easy to install.

Full example:
**No CTRF reporter? No problem!**

Use [junit-to-ctrf](https://github.com/ctrf-io/junit-to-ctrf) to convert a JUnit report to CTRF:

```sh
npx junit-to-ctrf path/to/junit.xml
```

### Full example

``` yaml
name: Example workflow file
Expand Down

0 comments on commit 31a867a

Please sign in to comment.