Skip to content

Commit

Permalink
docs: add if: always()
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed May 29, 2024
1 parent b25a381 commit 9cd0bc0
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ jobs:
uses: actions/checkout@v4
- name: Run CTRF annotations
run: npx github-actions-ctrf path-to-your-ctrf-report.json
if: always()
```
### Generating All Tables
Expand All @@ -53,6 +54,7 @@ For a all tables, add the following to your workflow YAML:
``` yaml
- name: Publish CTRF Test Summary Results
run: npx github-actions-ctrf path-to-your-ctrf-report.json
if: always()
```
### Generating Test Summary Table
Expand All @@ -62,6 +64,7 @@ For a test summary table, add the `summary` argument to your workflow yaml:
``` yaml
- name: Publish CTRF Test Summary Results
run: npx github-actions-ctrf summary path-to-your-ctrf-report.json
if: always()
```

### Generating Detailed Test Table
Expand All @@ -71,6 +74,7 @@ For a test details table, add the `tests` argument to your workflow yaml:
``` yaml
- name: Publish CTRF Detailed Test Summary Results
run: npx github-actions-ctrf tests path-to-your-ctrf-report.json
if: always()
```

### Generating Failed Test Details Table
Expand All @@ -80,6 +84,7 @@ For a failed test details table, add the `failed` argument to your workflow yaml
``` yaml
- name: Publish CTRF Failed Test Summary Results
run: npx github-actions-ctrf failed path-to-your-ctrf-report.json
if: always()
```

### Generating Flaky Test Details Table
Expand All @@ -89,6 +94,7 @@ For a flaky test details table, add the `flaky` argument to your workflow yaml:
``` yaml
- name: Publish CTRF Flaky Test Summary Results
run: npx github-actions-ctrf flaky path-to-your-ctrf-report.json
if: always()
```

### Generating Fail annotations
Expand All @@ -99,6 +105,7 @@ For test annotations, add the `annotate` argument to your workflow yaml:
``` yaml
- name: Annotate failed tests
run: npx github-actions-ctrf annotate path-to-your-ctrf-report.json
if: always()
```

## Components
Expand Down

0 comments on commit 9cd0bc0

Please sign in to comment.