[ENG-1012] docs: cancelling runs from CI - #60
Conversation
A cancelled CI job stops reporting mid-run, so the run stays in progress until the project's inactivity timeout. `currents cancel` cancels it using the record key the job already holds, on any CI provider. - new page under @currents/cmd, listed in the subcommands and in SUMMARY - a "Cancelling Runs from CI" section on the cancel-run page, above the API and GitHub Action sections - a note on the GitHub Action section, since that route needs an API key
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 58 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
The GitHub Actions section had no landing page and no cancellation article, and the cancellation examples still required an API key plus the GitHub run id and attempt. - new "Cancel Runs on Workflow Cancellation" article: the `if: cancelled()` step, both credentials, and how it pairs with `cancel-in-progress: true` - the GitHub Actions README now lists what is in the section - the action examples in cancel-run.md use the record key the job already has, with the API key kept as a second option
SUMMARY.md conflicted because this branch had rewritten every list marker from `*` to `-`. Kept main's markers, which is what GitBook writes, and re-added the two new entries on top.
`currents cancel` now accepts --run-id / CURRENTS_RUN_ID as well as the CI build id. Also state what happens when a job does not set CURRENTS_CI_BUILD_ID: the generated CI build id includes the test framework, so a cancelling step that rebuilds the value from environment variables does not find the run. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QYks4ynK7rmCmDuVTVuo1b
![baz-reviewer[bot]](https://avatars.githubusercontent.com/in/933528?s=60&v=4){kind=small}
agoldis
changed the title
Points the input list at the action's README, which is where it is maintained, rather than at this page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
ci-build-id.md recommends `${{ github.repository }}-${{ github.run_id }}-${{ github.run_attempt }}`, and the other cancellation pages already use it. Also moves the GitLab CI build id to the pipeline level, where the reporting job reads the same value.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Both the command and the action accept either identifier; the intros only mentioned the CI build ID. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
![baz-app[bot]](https://avatars.githubusercontent.com/in/1124379?s=60&v=4){kind=small}
1 participant
User description
Documents cancelling a Currents run from CI: the
currents cancelcommand (currents-dev/currents-reporter#380, backend currents-dev/currents#3279) and the GitHub action (currents-dev/cancel-run-gh-action#11).What changed
resources/reporters/currents-cmd/currents-cancel.md— usage, GitHub Actions and GitLab examples, and the behaviours worth knowing: it is safe for every job of a parallelized run to call it, and cancelling before any results were uploaded succeeds rather than failing the step.getting-started/ci-setup/github-actions/cancel-runs.md— the GitHub Actions article: theif: cancelled()step, which credential to use, a full workflow, and how it pairs withconcurrency: cancel-in-progress: true, which is what creates abandoned runs in the first place.getting-started/ci-setup/github-actions/README.md— the section landing page was an empty heading. It now lists what is in the section, grouped as setup, reruns and cancellation.dashboard/runs/cancel-run.md— new "Cancelling Runs from CI" section, and the GitHub action examples now use the record key the job already has. The API key is documented as the second option rather than the only one, and the stale "api-token,github-run-idandgithub-run-attemptare still required" note is gone — none of them are required now.SUMMARY.mdentries for both new pages.Note on timing
The command ships in a future
@currents/cmdrelease and the action in a newv1tag; the director route both call has to be deployed first. Worth holding this until they are out.Generated description
Below is a concise technical summary of the changes proposed in this PR:
Document how the
currents cancelCLI and thecancel-run-gh-actionGitHub action stop in-progress Currents runs when a workflow is cancelled. Update the dashboard docs and GitHub Actions guides to explain credentials, run identification, and the new cancellation pages in navigation.cancel-run-gh-actionstep, example workflow inputs, and section navigation.Modified files (4)
Latest Contributors(2)
currents cancel, covering authentication, run identification, and the cases where repeated or early cancellation still succeeds.Modified files (3)
Latest Contributors(2)