Design traditional BOM generation CI job

[jaylamb]

Feature Design Add traditional (spreadsheet style) bill of materials (BOM) generation CI script (ci/generate-traditional-bom) which will create a directory (bom) within the project repository, if it does not already exist. The directory should be the target for the KiBom KiBOM_CLI script's output. This output should be a basic HTML BOM, which can be modified using a configuration file, bom.ini, which is automatically generated the first time the script is run.

_Note: The script requires the BOM be available in the XML format. The KiAuto eeschema_do script's bom_xml function should be used to produce this._

Feature Use Case This CI job will run automatically as a part of pull requests, releases, etc... and will produce a simple bill of materials for all printed circuit boards contained within a project repository.

Detailed Design

• [ ] Add KiBOM as a submodule to this project:

  git submodule add git@github.com:SchrodingersGat/KiBoM.git utilities/KiBOM

• [ ] Add ci/generate-traditional-bom to project:
  • [ ] Supported options:
    • [ ] --help: See other project scripts
    • [ ] --version: See other project scripts
  • [ ] function error(): See other project scripts
  • [ ] function abort(): See other project scripts
  • [ ] function display_help_text(): See other project scripts
  • [ ] function display_version(): See other project scripts
  • [ ] function main(): See other project scripts
  • [ ] function generate_traditional_bom():

local schematics; mapfile -t schematics < <( git -C "$repository" ls-files '*.sch' ':!:*-sheet-*.sch' | xargs -r -d '\n' -I '{}' find "$repository/{}" ); readonly schematics

for schematic in "${schematics[@]}"; do
    if ! "$repository/utilities/KiAuto/src/eeschema_do" bom_xml "$schematic" "$repository"; then
        abort
    fi  
done

local netlists; mapfile -t netlists < <( find *.xml ); readonly netlists

    for netlist in "${netlists[@]}"; do
        local bom_name=$( basename "$netlist" .xml )
        if ! python3 "$repository/utilities/KiBOM/KiBOM_CLI.py" -d bom "$netlist" "$bom_name.html"; then
            abort
        fi  
done

• [ ] Add traditional bill of materials generation to .github/workflows/ci.yml:

  generate-traditional-bom:
  name: Generate traditional BOM
  runs-on: ubuntu-20.04
  steps:
      - uses: actions/checkout@v2
        with:
            submodules: recursive
      - name: Generate traditional BOM
        shell: bash
        run: ./ci/generate-traditional-bom

[apcountryman]

A few things:

• bom/BOM should be replaced with boms/BOM(s) for consistency with the schematic PDF(s) generation CI job/script.
• The KiBoM submodule should use a relative path to support project submodule collocation.
• It looks like eeschema_do bom_xml generates an XML BOM, not a netlist. I vaguely remember documentation saying that KiBoM needs a netlist so the documentation may have previously referred to it as such.
• There may be issues with the find invocation (the * may be expanded by the shell instead of being passed to find).
• KiBOM_CLI.py can be run directly. Explicitly invoking python3 is not necessary.
• KiBoM supports CSV, XML, and XSLX in addition to HTML. Might as well generate BOM(s) in all available formats.
• Generated BOM(s) are not uploaded.

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