Skip to content

Commit 34f1aa0

Browse files
committed
add section how does it work
1 parent 822e4d7 commit 34f1aa0

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ And then add the plugin's name to the list of build plugins in `netlify.toml` fi
2121

2222
*note:* this plugin assumes you have already installed Cypress as a dev NPM dependency.
2323

24+
## How does it work
25+
26+
When Netlify Build runs, it "knows" the output folder name and calls the `netlify-plugin-cypress` after the build has finished with that folder. Then the plugin runs Cypress tests using its [NPM module API](https://on.cypress.io/module-api). If the tests pass, the plugin finishes and the Netlify deploy starts.
27+
2428
## Examples
2529

2630
### basic

0 commit comments

Comments
 (0)