GitHub Action reference
Every input, output, and permission for the millionco/react-doctor Action. For setup and the full workflow file, see GitHub Actions setup.
Inputs
Set inputs with a with: block under the step. Every input is optional.
- uses: millionco/react-doctor@v2
with:
blocking: warning
scope: full| Input | Default | Description |
|---|---|---|
blocking | error | Severity that fails the workflow: |
scope | changed | On pull requests, |
comment | true | Create or update a sticky PR summary comment |
review-comments | true | Post inline review comments on changed lines (pull requests only) |
commit-status | true | Show the score and error/warning counts next to the commit (needs
|
project | * | Workspace project(s) to scan, comma-separated. |
directory | . | Project directory to scan |
node-version | 24 | Node.js version to use |
version | latest |
|
Outputs
Read outputs in later steps with ${{ steps.<step-id>.outputs.<name> }}.
| Output | Description |
|---|---|
score | Health score (0 to 100). Empty when scoring was unavailable |
total-issues | Total diagnostics; on pull requests, the number your change introduced |
fixed-issues | On pull requests, the number of issues your change resolved (otherwise 0) |
error-count | Error diagnostic count |
warning-count | Warning diagnostic count |
affected-files | Number of files with diagnostics |
The score output is empty in offline mode, or when the score API is unreachable, so handle that case if you read it in a later step.
Permissions
A workflow can only read your code by default. The Action needs these added under permissions:.
| Permission | Why it is needed |
|---|---|
contents: read | Check out and read your code. Required |
pull-requests: write | Read the changed-file list and post inline review comments. Drop to
|
issues: write | Post the sticky summary comment (a PR comment uses the issues API) |
statuses: write | Show the score and counts next to the commit. Omit if you set
|