1.5 KiB
Deploy Cypress Documentation
Table of Contents
Automatic Deployment
Any commits or PR requests merged that touch any file in the docs directory
will trigger a deployment, once the commit lands in the master branch.
But this deployment will only happen if the job docs-tests succeeds.
See circle.yml job definition file for up-to-date information.
Manual Deployment
You can only deploy the Cypress documentation manually if you are a member of the Cypress organization.
npm run deploy
You 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 --scrape
By default, only deploying from master branch is set, 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 | pbcopy
Check Latest Deployed Version
You can see the latest deployed version, including deployment date at https://docs.cypress.io/build.json