feat: rework test phases to make onSuccess default

BREAKING CHANGE: now the onSuccess step is the default testing
step, running the Cypress tests against the preview or production
deploy. Another change is the default browser is Chromium instead
of Electron.

Author: bahmutov

README.md

@@ -177,9 +177,9 @@ package = "netlify-plugin-cypress"
 
 See [cypress-example-kitchensink](https://github.com/cypress-io/cypress-example-kitchensink) for instance.
 
-### Chromium
+### browser
 
-By default all tests run using built-in Electron browser. If you want to use Chromium:
+By default all tests run using Chromium browser. If you want to use Electron:
 
 ```toml
 [build]
@@ -195,7 +195,8 @@ publish = "build"
 [[plugins]]
 package = "netlify-plugin-cypress"
   [plugins.inputs]
-  browser = "chromium"
+  # allowed values: electron, chromium
+  browser = "electron"
 ```
 
 ### testing SPA routes
@@ -294,6 +295,12 @@ Name | Description
 [bahmutov/eleventyone](https://github.com/bahmutov/eleventyone) | Example used in [Test Sites Deployed To Netlify Using netlify-plugin-cypress](https://glebbahmutov.com/blog/test-netlify/) tutorial
 [gatsby-starter-portfolio-cara](https://github.com/bahmutov/gatsby-starter-portfolio-cara) | A Gatsby site example
 
+## Major upgrades
+
+### v1 to v2
+
+- The default browser has been switched to Chromium. If you want to use the built-in Electron use an explicit option [browser](#browser)
+
 ## Debugging
 
 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`

manifest.yml

@@ -1,26 +1,44 @@
 name: netlify-plugin-cypress
 inputs:
-  # these settings apply during postBuild step
-  # when we are testing the site served from the distribution folder
+  # these settings apply during onSuccess step
+  - name: enable
+    description: Run tests against the preview or production deploy
+    default: true
+
   - name: record
+    description: Record test results to Cypress Dashboard
     default: false
+
   - name: spec
+    description: |
+      Run just the given spec or spec pattern,
+      equivalent to "cypress run --spec ..."
+
   - name: group
+    description: |
+      If recording to Cypress Dashboard,
+      pass the group name with "cypress run --record --group ..."
+
   - name: tag
-  - name: spa
-  # by default run the tests
-  - name: skip
-    default: false
-  # by default the tests run in Electron
-  # but because of the dependency we download Chromium
-  # so you can set "browser = electron"
+    description: |
+      If recording to Cypress Dashboard,
+      pass the tag with "cypress run --record --tag ..."
+
+  # Cypress comes with built-in Electron browser
+  # and this NPM package installs Chromium browser
   - name: browser
-    default: electron
+    description: Allowed values are chromium, electron
+    default: chromium
 
   # tells the plugin how to start the server using custom command
   # and waiting for an url, record to the dashboard, tag, etc
   # see README "testing the site before build"
   - name: preBuild
+    description: Run tests before building the site
 
-  # you can control how the plugin runs the tests after deploy
-  - name: onSuccess
+  # tells the plugin to start a static server during postBuild
+  # and test just the built static site.
+  # see README "testing the site after build"
+  # NOTE: does not execute Netlify API redirects or functions
+  - name: postBuild
+    description: Run tests against the built static site