Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 2.79 KB

README.md

File metadata and controls

46 lines (26 loc) · 2.79 KB
Raw

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.

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.

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.

  1. Bump the cypress-example-kitchensink devDependency within this package's package.json.

  2. Run yarn and yarn workspace @packages/example build to build the app and spec files.

  3. 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

This command deploys directly to production! Before executing it, ensure everything looks correct in the ./build directory.

yarn workspace @packages/example deploy