Canceling Runs
Cancelling cypress tests runs via dashboard
Runs that are currently in progress can be cancelled using the 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 the "Cancel Run" button in the Runs Feed view.
Cancelling cypress tests run from Runs Feed view
You can also cancel a run when from the 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 will be marked as "Cancelled", depending on test's status, it can also become "Failed" or "Passed". See Run Status.
  • in-progress tests will run to completion, the dashboard will accept their result
  • attempts to start a new test for a cancelled run would fail with the error message Run is cancelled

How do cancelled runs affect insights?

  • Cancelled runs are excluded from Runs Duration Insights
  • Cancelled runs are excluded from Test / Spec Size Insights
  • Tests recorded as part of a cancelled run are still included in Tests Insights charts

How does 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 organizations on deprecated runs-based plans)

How does 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 the last known run status, for example
    • if no failed tests were recorded before the cancellation, the status check outcome will be a success
    • otherwise, the status check outcome will be a 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 the last known run status
Cancelling cypress tests run - GitHub PR comment

Slack / MS Teams

  • Currents will post a cancellation notification with the 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 the last known run results. and event type RUN_CANCELED See HTTP Webhooks for details.
Copy link
On this page
How to cancel Cypress tests run?
What happens when a run is cancelled?
How do cancelled runs affect insights?
How does cancelling a run affect test records plan usage?
How does cancelling a run affect integrations (GitHub, Slack, etc.)?