Skip to content

docs: cancelling a test session skips queued runs of every check type (product update 2026-10-26) - #753

Open
hlenke wants to merge 1 commit into
mainfrom
docs-release/2026-10-28-cancel-all-check-types
Open

hlenke wants to merge 1 commit into
mainfrom
docs-release/2026-10-28-cancel-all-check-types

Conversation

@hlenke

@hlenke hlenke commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

Cancelling a test session now also skips the queued runs of API checks and uptime monitors, not just Playwright Check Suites. Runs that already started finish normally. The Cancellation page and the checkly test and checkly trigger references still said only Playwright Check Suite runs can be cancelled. This PR updates concepts/cancellation.mdx, cli/checkly-test.mdx and cli/checkly-trigger.mdx.

Verified end to end against the released version.

Touches the same page as #650, #734, #749; merge order may matter.

🤖 Generated with Claude Code

…type (Checkly API, 2026-10-26)

Since 26 October 2026, cancelling a whole test session (Ctrl+C or
--max-failures in the CLI, or POST /v1/test-sessions/{id}/cancel with
an empty body) also skips the session's queued API, URL, TCP, DNS,
ICMP, gRPC, SSL and Traceroute runs. Each skipped run is reported
with status CANCELLED. A run that has already started still finishes.

The cancellation concept page and the checkly test and checkly trigger
references said that only Playwright Check Suite runs can be cancelled
and that other check types always run to completion. This updates those
sentences and adds that runs started with --no-record have no test
session to cancel.

Proven on the local stack (monorepo 5858d7e03f, CLI 10.0.0): sessions
of 40 checks per type end CANCELLED with 25 runs completed and 15
queued runs skipped; the same session without a cancel ends PASSED.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Oct 29, 2026, 2:10 AM

@hlenke hlenke changed the title docs: cancelling a test session now skips queued runs of every check type (Checkly API, 2026-10-26) docs: cancelling a test session skips queued runs of every check type (product update 2026-10-26) Oct 29, 2026

This branch was successfully deployed

1 active deployment
staging — 197d6a4e Deployed Oct 29, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant