Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Cancel or force-cancel a GitHub Actions workflow run.
github.cancelWorkflowRun requests cancellation of an active workflow run.
import { automation } from "automate.ax"
import { github } from "automate.ax/github"
export default automation("Cancel GitHub workflow", () => {
github.cancelWorkflowRun({
force: false,
owner: "SentsCo",
repository: "automate.ax",
runId: 123456789,
})
})
runId. force defaults to false; set it only when normal cancellation cannot stop the run. Returns {} after GitHub accepts the request. Cancellation is asynchronous, so use workflow-run triggers or getWorkflowRun to observe completion. Requires Actions write permission.