apcountryman / prototype-kicad-project-ci-cd

KiCad project CI/CD prototype.
Other
0 stars 1 forks source link

Design ERC CI job #1

Closed jaylamb closed 3 years ago

jaylamb commented 3 years ago

Add Electrical Rules Check (ERC) CI job. This job can then be run as a part of a commit or release to ensure a schematic's compliance with a project's as-configured electrical rules. The script should succeed silently, and present the results of any portion of the check that fails.

apcountryman commented 3 years ago

Changing ci/electrical-rules-check to ci/check-electrical-rules-compliance follows the script naming convention (verb first) and is slightly more descriptive.

If no schematic files are found, the script should succeed. To do this, eeschema_do should not be invoked if no schematic files are found.

It appears that eeschema_do's ERC check can only be run against a single top level schematic file at a time which will require looping over the list of found top level schematic files. Also, a schematic sheet file naming convention (<top level schematic name>-sheet-<sheet functional description>.sch) will need to be adopted.

Existing scripts currently capture the path to the repository in a variable named repository, not repository_dir.

Other than these, this design looks LGTM. I'll open a type-feature issue for implementing this new feature shortly.