embedded-pro/kicad-bot
CI quality gate for KiCad projects: ERC/DRC verification, BOM availability checks, visual diffs, and fabrication-output generation.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| run-verify | Run headless ERC/DRC verification (kicad-cli). | — | true |
| run-bom-check | Run BOM availability/lifecycle check (KiBot + KiCost). | — | false |
| run-diff | Render a visual schematic/PCB diff against a baseline ref. | — | false |
| run-fab | Generate the fabrication/documentation output package (KiBot). | — | false |
| quickstart | Auto-detect the project and run all enabled stages with zero config. | — | false |
| project-dir | Directory containing the KiCad project. | — | . |
| schematic | Path to the .kicad_sch file (auto-detected if omitted). | no | — |
| board | Path to the .kicad_pcb file (auto-detected if omitted). | no | — |
| kicad-version | Major KiCad version to install/use (8 | 9 | 10). | — | 9 |
| config-path | Path to kicad-bot.json (relative to project-dir if not absolute). | — | kicad-bot.json |
| fail-on-erc | Fail the build on ERC violations. | — | true |
| fail-on-drc | Fail the build on DRC violations. | — | true |
| drc-severity | Minimum severity that gates the build (error | warning | all). | — | error |
| fail-on-eol | Fail when any part is end-of-life / NRND / obsolete. | — | false |
| fail-on-unavailable | Fail when any part is out of stock at the configured distributors. | — | false |
| distributors | Comma-separated distributor list (e.g. 'Mouser,Digi-Key'). | — | Mouser,Digi-Key |
| kicost-config | Path to an existing KiCost config (otherwise one is generated from env). | no | — |
| diff-baseline-ref | Git ref to diff against. Defaults to the PR base when empty. | — | "" |
| output-dir | Directory for reports and artifacts. | — | kicad-bot-output |
| pr-comment | Render and upsert an idempotent PR comment. | — | true |
| upload-artifact | Upload the output directory as a workflow artifact. | — | true |
| artifact-name | Name of the uploaded artifact. | — | kicad-bot-output |
Outputs
| name | description |
|---|---|
| erc-violations | ERC violation count. |
| drc-violations | DRC violation count. |
| eol-parts | Count of EOL/NRND parts. |
| unavailable-parts | Count of out-of-stock parts. |
| report-path | Path to the markdown report. |
| metrics-path | Path to kicad_bot_metrics.json. |
| passed | 'true' when every enabled gate passed. |