Skip to content

Commit 0599e48

Browse files
committed
add example repos section
1 parent 34f1aa0 commit 0599e48

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,15 @@ Here is the most basic [Netlify config file](https://docs.netlify.com/configure-
3737
package = "netlify-plugin-cypress"
3838
```
3939

40+
The example file above should be enough to run Cypress tests in any existing Netlify project.
41+
4042
### recommended
4143

4244
We strongly recommend setting `CYPRESS_CACHE_FOLDER` to place the Cypress binary _inside the node_modules_ folder to [cache it between builds](https://on.cypress.io/caching)
4345

4446
```toml
47+
# explicit commands for building the site
48+
# and the folder to publish
4549
[build]
4650
command = "npm run build"
4751
publish = "build"
@@ -70,7 +74,6 @@ publish = "build"
7074
# ...remaining configuration...
7175
```
7276

73-
7477
### recording
7578

7679
To record test results and artifacts on Cypress Dashboard, set `record: true` plugin input and set `CYPRESS_RECORD_KEY` as an environment variable via Netlify Deploy settings.
@@ -165,6 +168,14 @@ Parameters you can place into `preBuild` inputs: `start`, `wait-on`, `wait-on-ti
165168

166169
See [netlify-plugin-prebuild-example](https://github.com/cypress-io/netlify-plugin-prebuild-example) repo
167170

171+
## Example repos
172+
173+
Name | Description
174+
--- | ---
175+
[netlify-plugin-cypress-example](https://github.com/cypress-io/netlify-plugin-cypress-example) | Runs Cypress tests on Netlify and records their results to Cypress Dashboard
176+
[netlify-plugin-prebuild-example](https://github.com/cypress-io/netlify-plugin-prebuild-example) | Runs tests twice, first using the development version of the site, then after Netlify builds the production bundles, runs the tests again
177+
[cypress-example-kitchensink](https://github.com/cypress-io/cypress-example-kitchensink) | Runs only a subset of all tests before publishing the folder to Netlify
178+
168179
## Debugging
169180

170181
Set environment variable `DEBUG=netlify-plugin-cypress` to see the debug logs. To see even more information, set `DEBUG=netlify-plugin-cypress,netlify-plugin-cypress:verbose`

0 commit comments

Comments
 (0)