NAME

repomatic cancel-runs - Cancel in-progress workflow runs for a branch

SYNOPSIS

repomatic cancel-runs [OPTIONS]

DESCRIPTION

Cancel the in-progress and queued workflow runs of a branch.

Fired when a pull request closes: GitHub does not cancel PR-triggered runs on close, so the branch's live runs would burn CI minutes to completion. The repository is resolved by the gh CLI from GH_REPO or the current checkout.

OPTIONS

--branch TEXT

Head branch whose in-progress and queued runs to cancel.
[required]

--current-run-id TEXT

Run ID to spare (the cancelling run itself). Defaults to $GITHUB_RUN_ID.

--help / -h

Show this message and exit.

ENVIRONMENT

CANCEL_RUNS_BRANCH

Head branch whose in-progress and queued runs to cancel.

GITHUB_RUN_ID

Run ID to spare (the cancelling run itself). Defaults to $GITHUB_RUN_ID.

CANCEL_RUNS_CURRENT_RUN_ID

Run ID to spare (the cancelling run itself). Defaults to $GITHUB_RUN_ID.

CANCEL_RUNS__CLICK_DEFAULT_HELP

Show this message and exit.

EXIT STATUS

0

Success.

1

A runtime error, or an aborted prompt (Ctrl-C, a declined confirmation).

2

A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.

EXAMPLES

From the cancel-runs workflow, sparing its own run

repomatic cancel\-runs \-\-branch "$BRANCH"

AUTHORS

Kevin Deldycke