Skip to content

Commit

Permalink
docs: test list docs - version
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Nov 5, 2024
1 parent 8f0a2e5 commit e91bfc9
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 3 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,16 @@ For a test details table, add the `tests` command to your workflow yaml:
if: always()
```

### Generating Test list

For a simple list of tests, add the `test-list` command to your workflow yaml:

```yaml
- name: Publish CTRF test list
run: npx github-actions-ctrf test-list path-to-your-ctrf-report.json
if: always()
```

### Generating Failed Test Details Table

For a failed test details table, add the `failed` command to your workflow yaml:
Expand Down Expand Up @@ -522,6 +532,10 @@ npm run report

![Tests](images/tests.png)

### Test list

![Tests](images/test-list.png)

### Failed details

![Failed](images/failed.png)
Expand Down
Binary file added images/test-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "github-actions-ctrf",
"version": "0.0.48",
"version": "0.0.49",
"description": "View test results directly within your GitHub workflow summary and Pull Requests",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit e91bfc9

Please sign in to comment.