Skip to content

docs: Update README #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 5, 2025
Merged

docs: Update README #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f45c17
docs: Update README
mhan83 Feb 5, 2025
bab9732
update install command
mhan83 Feb 5, 2025
831df52
Run readme through prettier
mhan83 Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 45 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This Playwright plugin reports each project to your Sauce Labs account.
## Installation

Install from npm:

```sh
npm install @saucelabs/playwright-reporter
```
Expand All @@ -16,21 +17,22 @@ Set the `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables to allow t
## Usage

Add to the default reporter:

```sh
npx playwright test --reporter=line,@saucelabs/playwright-reporter
```

Use only `@saucelabs/playwright-reporter`:

```sh
npx playwright test --reporter=@saucelabs/playwright-reporter
```

You can also configure it using `playwright.config.js`. To do that, add `'@saucelabs/playwright-reporter'` to the reporter section of your configuration:

```js
const config = {
reporter: [
['@saucelabs/playwright-reporter'],
],
reporter: [['@saucelabs/playwright-reporter']],
// Rest of your config goes here
};
```
Expand All @@ -40,40 +42,49 @@ const config = {
`@saucelabs/playwright-reporter` is configurable through your `playwright.config.js` or `playwright.config.ts` file.

Example:

```js
const config = {
reporter: [
['@saucelabs/playwright-reporter', {
buildName: 'My Playwright Build',
region: 'us-west-1',
tags: [
'playwright',
'demo',
],
}],
[
'@saucelabs/playwright-reporter',
{
buildName: 'My Playwright Build',
region: 'us-west-1',
tags: ['playwright', 'demo'],
},
],
],
// Rest of your config goes here
};
```

| Name | Description | Type |
|--------------|--------------------------------------------------------------------------------------------------|--------------------------------|
| `buildName` | Sets a build ID. <br> Default: `''` | `string` |
| `tags` | Tags to add to the uploaded Sauce job. <br> Default: `[]` | `string[]` |
| `region` | Sets the region. <br> Default: `us-west-1` | `us-west-1` \| `eu-central-1` |
| `upload` | Whether to upload report and assets to Sauce Labs. <br> Default: `true` | `boolean` |
| `outputFile` | The local path to write the Sauce test report. Can be set in env var `SAUCE_REPORT_OUTPUT_NAME`. | `string` |
| `mergeVideos` | Whether to merge all video files generated by Playwright. This is useful when used with the `upload` option to upload the test report to Sauce Labs since it will allow you to view the merged video in the Sauce Labs Test Results page. **Requires ffmpeg to be installed.**<br> Default: `false` | `boolean` |
| Name | Description | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| `buildName` | Sets a build ID. <br> Default: `''` | `string` |
| `tags` | Tags to add to the uploaded Sauce job. <br> Default: `[]` | `string[]` |
| `region` | Sets the region. <br> Default: `us-west-1` | `us-west-1` \| `eu-central-1` |
| `upload` | Whether to upload report and assets to Sauce Labs. <br> Default: `true` | `boolean` |
| `outputFile` | The local path to write the Sauce test report. Can be set in env var `SAUCE_REPORT_OUTPUT_NAME`. | `string` |
| `mergeVideos` | Whether to merge all video files generated by Playwright. This is useful when used with the `upload` option to upload the test report to Sauce Labs since it will allow you to view the merged video in the Sauce Labs Test Results page. **Requires ffmpeg to be installed.**<br> Default: `false` | `boolean` |

## Limitations

Some limitations apply to `@saucelabs/playwright-reporter`:
* For Playwright versions before v1.16.3, the Playwright version is not reported to Sauce Labs.
* The browser version is not reported to Sauce Labs.

- For Playwright versions before v1.16.3, the Playwright version is not reported to Sauce Labs.
- The browser version is not reported to Sauce Labs.

## Development

### Running integration tests
### Setup

1. Install dependencies: `npm ci`
2. Setup git hooks: `npm run prepare`. This setups pre-commit hooks to format
and lint staged code.
3. Build: `npm run build`

### Running Locally

There are tests included in `tests/integration` where the reporter is referenced
directly.
Expand All @@ -84,22 +95,28 @@ $ cd tests/integration
$ npx playwright test
```

### Running Locally

If you have playwright tests outside of the repo, you can link and install the
If you have playwright tests outside of the repo, you can use
[npm link](https://docs.npmjs.com/cli/v11/commands/npm-link) to install the
reporter to run in your external repo.

```sh
$ npm run build
$ npm link
$ npm link @saucelabs/playwright-reporter
$ npx playwright test --reporter=@saucelabs/playwright-reporter
```

### Debug

After linking with `npm link`, you can run your Playwright tests with the environment variable `DEBUG="@saucelabs/playwright-reporter:*"` to see additional debug output.
You can run your Playwright tests with the environment variable
`DEBUG="@saucelabs/playwright-reporter:*"` to see additional debug output.

```sh
$ DEBUG="@saucelabs/playwright-reporter:*" npx playwright test --reporter=@saucelabs/playwright-reporter
```

## Releasing

New versions are released with a manual GitHub Actions workflow.

1. Go to https://github.com/saucelabs/sauce-cypress-plugin/actions/workflows/release.yml
2. Run the workflow and specify the branch and release type (`major`, `minor`,
or `patch`).
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"install-playwright": "playwright install",
"test": "npm run install-playwright && npm run build && jest",
"build": "tsc",
"prepare": "husky",
"lint": "prettier --check '**/*.{js,ts,mjs,cjs}' && eslint .",
"fmt": "prettier --write '**/*.{js,ts,mjs,cjs}'",
"release": "npm run build && release-it --github.release",
Expand Down
Loading