How to record CI builds in Cypress Dashboard?
You can pass Cypress CLI options to @knapsack-pro/cypress and thanks to this send a recorded run to Cypress Dashboard.
export CYPRESS_RECORD_KEY=your-record-key $(npm bin)/knapsack-pro-cypress --record
Cypress will try to merge your tests executed with @knapsack-pro/cypress on parallel nodes into a single run in Cypress Dashboard. Merging is done based on automatically detected CI build ID for most CI providers.
If Cypress can't determine CI build ID for your CI provider then you need to provide the option --ci-build-id.
$(npm bin)/knapsack-pro-cypress --record --ci-build-id $CI_BUILD_ID
You must use the CI build ID variable for your CI provider instead of the above example $CI_BUILD_ID.
| CI provider | Environment variable |
|---|---|
| AppVeyor | APPVEYOR_BUILD_NUMBER |
| Bamboo | BAMBOO_BUILD_NUMBER |
| Buildkite | BUILDKITE_BUILD_NUMBER |
| Circle | CIRCLE_WORKFLOW_ID, CIRCLE_BUILD_NUMBER |
| Cirrus | CIRRUS_BUILD_ID |
| Codeship | CI_BUILD_NUMBER |
| Codeship Basic | CI_BUILD_NUMBER |
| Codeship Pro | CI_BUILD_ID |
| Drone | DRONE_BUILD_NUMBER |
| Gitlab | CI_PIPELINE_ID, CI_JOB_ID, CI_BUILD_ID |
| Github Actions | GITHUB_RUN_ID |
| Heroku | HEROKU_TEST_RUN_ID |
| Jenkins | BUILD_NUMBER |
| Semaphore 1.0 | SEMAPHORE_BUILD_NUMBER |
| Semaphore 2.0 | SEMAPHORE_WORKFLOW_ID |
| Travis | TRAVIS_BUILD_ID |
| Codefresh.io | CF_BUILD_ID |