allspiceio/Generate BOM

Generate a BOM for the project using py-allspice and attach it as an artifact to the run. Works for Altium, OrCAD, DeHDL, System Capture and DxDesigner projects.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jun 15, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: allspiceio/generate-bom@8611f18c064cc0b570be63dca1a73eb4121f42df # v0.12.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
source_pathPath to the source file from the root of the repo. This should be: - A .PrjPcb file for Altium projects. - A .DSN file for OrCAD projects. - An .SDAX file for System Capture projects. - A .CPM file for DeHDL projects. - A .PRJ file for DxDesigner projects. yes
output_file_nameName of the output fileyesbom.csv
columnsA path to a JSON file mapping columns to the attributes they are from. yes
group_byA comma-separated list of columns to group the BOM by. If not present, the BOM will be flat. ""
variantThe variant of the project to generate the BOM for. If not present, the BOM will be generated for the default variant. Not supported for OrCAD, DeHDL, or DxDesigner projects. ""
log_levelThe level at which to log. Use "DEBUG" to get more information, such as about which file was used to match which device sheet. noINFO
auth_tokenThe AllSpice Hub Auth token to use. If not provided, the autogenerated token for the run is used. no${{ github.token }}
use_legacy_altium_rendererForce use of the legacy Altium renderer in case the new one is causing issues. nofalse

no outputs