Any commits landed in develop branch of this repository will be deployed
to staging environment if end to end tests pass and can be previewed at https://docs-staging.cypress.io.
Any commits landed in master branch will be deployed to the production
environment and can be previewed at https://docs.cypress.io.
Refer to the circle.yml job definition file for up-to-date information.
You can only deploy the Cypress documentation manually if you are a member of the Cypress organization and have the necessary credentials files.
npm run deployYou can specify all options for deploying via command line arguments. For example to deploy to production and scrape the docs:
npm run deploy -- --environment production --scrapeBy default, only deploying from master branch is allowed, but you can force
deployment by using --force option.
To debug deployment actions, run with DEBUG=deploy ... environment variable.
Note
on CI, the deployment and scraping configuration are passed via environment
variables support__aws_credentials_json and support__circle_credentials_json
which are just JSON files as strings.
cat support/.circle-credentials.json | pbcopyYou can see the latest deployed version, including deployment date at:
| Env | Site |
|---|---|
| Master | https://docs.cypress.io/build.json |
| Staging | https://docs-staging.cypress.io/build.json |