oaslananka/BoardReadyOps
Fabrication readiness checks for KiCad PCB projects. Identify and fix issues before you order boards.
View on GitHubTrust Signals
- Scorecard Score
- Scorecard 6–8scored May 25, 2026
- Maintenance Recency
- Activelast commit Jul 11, 2026
- License
- MIT
Pinned Snippet
uses: oaslananka/boardreadyops@7ab61d404c17319d48ef953e57d3ba2476ca9fbd # v1.8.3tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Directory to scan. | no | . |
| project | Explicit .kicad_pro path. If omitted, all discovered projects are scanned. | no | "" |
| config | Path to boardreadyops.yml. | no | boardreadyops.yml |
| mode | warn or enforce | no | warn |
| release-mode | Manufacturing release context. One of prototype, pilot, production. Empty disables release mode behavior. | no | "" |
| require-kicad | Fail when kicad-cli is not available. | no | false |
| kicad-cli | Explicit kicad-cli path. | no | "" |
| bom | BOM source path or "auto". | no | auto |
| pinmap | Pinmap file path. Empty disables pinmap rules. | no | "" |
| variant | KiCad variant name used by variant-aware BoardReadyOps rules. | no | "" |
| gate | Gate name from boardreadyops.yml. Empty auto-detects pull_request, main, or release. | no | "" |
| sarif | Output SARIF path. Empty disables. | no | boardreadyops.sarif.json |
| json | Output JSON findings path. Empty disables. | no | boardreadyops.findings.json |
| markdown | Output Markdown report path. Empty disables. | no | boardreadyops.report.md |
| hbom | Output CycloneDX hardware SBOM path. Empty disables. | no | "" |
| upload-sarif | Upload SARIF to GitHub Code Scanning. | no | true |
| upload-artifacts | Upload reports as workflow artifacts. | no | true |
| comment-pr | Post a sticky Markdown comment on pull requests. | no | true |
| comment-format | Pull request comment style. One of report (full Markdown report) or review (compact release-review summary). | no | report |
| artifact-name | Workflow artifact name. | no | boardreadyops |
| fail-on | Severity threshold above which the action exits non-zero. One of critical, high, medium, low, never. | no | high |
| annotations | Emit ::error/::warning workflow annotations. | no | true |
| log-level | Log level. One of debug, info, warn, error, critical, silent. | no | info |
| log-format | Log format. One of text, json. | no | text |
| log-file | Optional log file path inside the workspace. | no | "" |
| log-file-max-bytes | Rotate the log file after this many bytes. Empty uses the default. | no | "" |
| log-file-retention | Number of rotated log files to keep. Empty uses the default. | no | "" |
Outputs
| name | description |
|---|---|
| findings | Total finding count. |
| critical | Count of critical findings. |
| high | Count of high findings. |
| medium | Count of medium findings. |
| low | Count of low findings. |
| sarif-path | SARIF output path if produced. |
| json-path | JSON output path if produced. |
| markdown-path | Markdown output path if produced. |
| hbom-path | CycloneDX hardware SBOM output path if produced. |