Skip to content
This repository has been archived by the owner on Jul 24, 2022. It is now read-only.

Commit

Permalink
Update readme with workdir parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
evanhsu committed Feb 4, 2021
1 parent bac20bb commit 8c61d96
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,19 @@ This Github action enables you to take the screenshots and videos generated by C

**Required** Slack channels to upload to

### `workdir`

**Optional** The folder where Cypress stores screenshots and videos on the build machine.

Default: `cypress`

(this relative path resolves to `/home/runner/work/<REPO_NAME>/<REPO_NAME>/cypress`)

If your project uses Cypress from the project root folder, the default value will work for you.
But if your project uses Cypress in a subfolder (like most monorepos), you'll need to provide the relative path to that folder
(i.e. `e2e/cypress`).
(Don't include a trailing slash on your path!)

## Examples

### Upload results after every push
Expand Down

0 comments on commit 8c61d96

Please sign in to comment.