Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
daun committed Sep 8, 2023
1 parent d788c4d commit 1fdb2a5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A GitHub action to report Playwright test results as pull request comments.
### Basic usage

Playwright must be configured to [generate a JSON report](https://playwright.dev/docs/test-reporters#json-reporter)
and write it to disk. This action receives the report file path as input.
and write it to disk. This action receives the report file path as input, in this case `results.json`:

```yaml
jobs:
Expand All @@ -33,7 +33,9 @@ jobs:
- uses: actions/setup-node@v3
with:
node-version: 20

- run: PLAYWRIGHT_JSON_OUTPUT_NAME=results.json npx playwright test --reporter json

- uses: daun/playwright-report-comment@v1
with:
report-file: results.json
Expand Down

0 comments on commit 1fdb2a5

Please sign in to comment.