9e60aeba8f
* chore: update build-npm-modules script * chore: update build-npm-modules script * chore: update build-npm-modules script * chore: update build-npm-modules script * chore: update lerna to 6 * [run ci] * try caching build step * we can't clean without building after * add dependencies on scripts for npm packages * update commands * add config for data-context build step * fix output configurations for npm packages, add gitignores * revert changes to config and data-context build steps * fix outputs * run with cache * fix outputs for cli * actually fix outputs * test with cache --------- Co-authored-by: astone123 <adams@cypress.io>
Example
This package is responsible for copying the cypress/e2e and app files from cypress-example-kitchensink into the cypress repository.
The cypress/e2e tests, pulled into this package from the kitchen sink app, are used for scaffolding user's e2e tests in packages/data-context and in npm/create-cypress-tests.
The app content, pulled into this package from the kitchen sink app, is published to cypress-io/cypress repository's Github page, https://example.cypress.io.
Updating Content
THERE'S LIKELY NO REASON YOU NEED TO EDIT ANY OF THE CODE IN THIS PACKAGE.
- Want to edit the
exampletests? -> edit it here instead. - Want to edit the actual https://example.cypress.io website? edit it here instead.
Major Version Bumps of Cypress
If any of the breaking changes in the next major release requires updates to Cypress commands or APIs, verify the site content in cypress-example-kitchensink is up-to-date and that all examples that will be scaffolded can successfully run with the breaking change.
Using a new version of cypress-example-kitchen-sink
When a commit is merged into master, a new version of the cypress-example-kitchen-sink repo is released automatically to npm. When this happens, you will need to update the example's dependency to match the newly released version.
-
Bump the
cypress-example-kitchensinkdevDependencywithin this package'spackage.json. -
Run
yarnandyarn workspace @packages/example buildto build the app and spec files. -
Create a new pull-request following this repo's pull request instructions.
Building
After running yarn you must build the app + spec files.
yarn workspace @packages/example build
This copies the cypress/e2e and files from cypress-example-kitchensink, modifies them to point to https://example.cypress.io and creates the example tests.
Deploying
yarn workspace @packages/example deploy