Repository navigation
CI: Cancel workflow when format check fails - #36664
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review. WalkthroughThe ChangesFormat job cancellation
Priority: ⬇️ Low Merge Risk: ⚪ Minimal · up to No identified issue blocks merging. A failed format check is configured to request workflow cancellation; its live effect has not been confirmed. ✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
📝 Generate docstrings
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Delegate feedback — PR #36663 confidence escalation (normal-generated / test-storybooks-portable-vue3) What failed: On head Log access blocked: CircleCI job logs are auth-gated (anonymous v1.1/v2 endpoints 404; web page requires login), so the snackbar could not be inspected directly. The [ Prevalence evidence for a flaky/infra cause: On clean Why a code regression is unlikely: 5 sibling vitest jobs exercising the same changed plugin code passed on this same head; portable-react/portable-nextjs/portable-svelte passed unchanged; every failure found on clean Requested action (runnable): rerun the failed CircleCI job via GitHub Actions: Any failing delegate idea that turns out to be snackbar is always escalation (or retry-with-changed-factors), never a clear. Delegates: if you find the actual root cause instead of a flake, escalate that directly. |
What I did
Cancel the current CircleCI workflow when
format-checkfails, using the sameworkflow.cancelOnFailure()helper as type checking and unit tests. Successful runs retain their existing parallelism. This uses the existingWORKFLOW_CANCELERcredential.Validation: generated and parsed the docs, normal, merged, and daily configurations; verified that each format job has exactly one
on_failcancellation step afteryarn fmt:check. Focused formatting and lint checks passed. Live CircleCI cancellation still needs the manual check below.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
WORKFLOW_CANCELERcredential available.format-checkfails, runsCancel current workflow, and stops the remaining workflow jobs.Caution
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsDeclare whether manual QA will be needed for this PR during the next release, through
qa:neededorqa:skipMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary Release - 🚫 Not run
This PR does not have a canary release associated.
In-repo PRs: add the
ci:canarylabel. Later pushes republish while the label remains.Fork PRs: the label does nothing (a later push must not auto-publish). A maintainer publishes from this repository with Run workflow and the
prinput.branchandshaare optional; if more than one is set, they must be the same commit. The fork author does not need to do anything.