Cancel Run

You can stop cypress test by cancelling runs that are currently in-progress using dashboard controls. 
Cancelling a run can be useful for:
preventing run from timing out
optimizing usage of your CI provider resources
reducing the number of recorded tests
Please note: Cancelling a run cannot be undone
How to cancel Cypress tests run?
In-progress runs can be cancelled by clicking "Cancel Run" button in Runs Feed view.
Cancelling cypress tests run from Runs Feed view
You can also cancel a run when from Run Details view.
Cancelling cypress tests run from Run Details view
What happens when a run is cancelled?
Cancelling a run affects in-progress and pending tests, as well as integrations and runs analytics.
the run's status will become "Cancelled"
in-progress tests will run to completion, the dashboard will accept their result
attempts to start a new test for cancelled run would fail with error message Run is cancelled
How cancelled runs affect insights?
Cancelled runs are excluded from Runs Insights - only completed runs appear in Runs Insights charts
Tests recorded as part of a cancelled run are still included in Tests Insights charts
How cancelling a run affect test records plan usage?
Only fully recorded tests consume your organization's test records limit. 
Cancelled runs do consume your organization's runs limit (for organization on deprecated runs-based plans)
How cancelling a run affect integrations (GitHub, Slack, etc.)?
GitHub / BitBucket Commit Status Check
Commit status checks will display Cancelled by <username> message
Commit status check outcome will be set according to last known run status, for example
if no failed tests were recorded before the cancellation, status check outcome will be success
otherwise status check outcome will be failure
Cancelling cypress tests run - GitHub commit status message
GitHub PR Comment
Currents will post a new PR comment with Cancelled by <username> message
PR comment details will be set according to last known run status
Cancelling cypress tests run - GitHub PR comment
Slack / MS Teams
Currents will post a cancellation notification with last known run results
Cancelling cypress tests run - Slack message example
Cancelling cypress tests run - MS Teams example
HTTP Webhook Integration
A new HTTP POST request will be emitted with  last known run results. and event type RUN_CANCELED  See HTTP Webhooks for details.
​

Last modified 2mo ago

Copy link

Contents

How to cancel Cypress tests run?

What happens when a run is cancelled?

How cancelled runs affect insights?

How cancelling a run affect test records plan usage?

How cancelling a run affect integrations (GitHub, Slack, etc.)?