Skip to content

CI

A starter GitHub Actions workflow, and the flags that make a scan useful in a pipeline.

Add the workflow from the project root:

terminalbash
npx @abiramcodes/angular-doctor@latest ci install

Pull requests

The workflow checks out the repository and runs Angular Doctor. Use --scope changed to report files that differ from HEAD in the working tree; a clean CI checkout falls back to a full scan. --json prints a single object for another job to read.

--score-only prints the number and nothing else, which is enough for a status check that tracks the score over time.

terminalbash
npx @abiramcodes/angular-doctor@latest --scope changed --json
npx @abiramcodes/angular-doctor@latest --score-only

Notes

The workflow file is not overwritten

ci install writes .github/workflows/angular-doctor.yml only when that file is not already there. Edit it freely once it exists.

A pipe prints no color

In CI, stdout is not a terminal, so the summary prints as plain text. Use --json when another job needs the result.