Repository navigation
chore: document effect-needs-cleanup exception in BlogLinks #18
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # React Doctor — finds security, performance, correctness, accessibility, | |
| # bundle-size, and architecture issues in React codebases. | |
| # | |
| # Docs: https://www.react.doctor/ci | |
| # Source: https://github.com/millionco/react-doctor | |
| name: React Doctor | |
| on: | |
| # Scans the PR's changed files and posts a sticky summary comment listing only the new issues introduced relative to the merge base of the target branch. | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| # Scans `master` on every push to track the health-score trend and catch regressions that slipped past PR review. | |
| push: | |
| branches: ["master"] | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| issues: write | |
| statuses: write | |
| # Cancels any in-flight scan for the same PR (or branch, on push) the moment a new commit arrives, so reviewers only ever see the latest run. | |
| concurrency: | |
| group: react-doctor-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| react-doctor: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # fetch-depth: 0 gives React Doctor the full git history it needs to find the merge base with the target branch. Without it a shallow checkout has no merge base, so PR runs can't compare against the base and fall back to reporting every issue in the changed files (pre-existing ones included) instead of only the ones the PR introduced. | |
| - uses: actions/checkout@v5 | |
| with: | |
| fetch-depth: 0 | |
| - uses: millionco/react-doctor@v2 | |
| with: | |
| # Blocking gate: fail the check on new error-severity findings. | |
| blocking: error | |
| # Advisory extras stay default: sticky PR summary comment, inline | |
| # review comments, and a commit status with the health score. | |
| # Full reference: https://www.react.doctor/ci | |
| # | |
| # Security: @v2 is a floating major tag that may move. For supply-chain- | |
| # hardened CI, pin to a full commit SHA with a version comment instead: | |
| # uses: millionco/react-doctor@<sha> # v2.x.x | |
| # with: | |
| # blocking: warning # Gate level: "none" (advisory) | "warning" (fail on any) | "error" (fail on errors) | |
| # scope: full # On PRs, scan the whole project instead of just changed files | |
| # scope: full # On PRs, scan the whole project instead of just changed files | |
| # comment: false # Disable the sticky PR summary comment | |
| # review-comments: false # Disable inline review comments on changed lines | |
| # commit-status: false # Disable the commit status (score + counts, links to the run) | |
| # version: "0.4.0" # Pin to a specific react-doctor version instead of "latest" | |
| # directory: apps/web # Scan a sub-directory (default: ".") | |
| # project: "web,admin" # In a monorepo, scan specific workspace project(s) |