Go to file
shrikanth-allspice c2b88479bf
Merge pull request 'fix: Fix the custom action to run' (#1) from AllSpice/generate-bom-docker:jt/fix-pip into main
Reviewed-on: #1
2024-04-09 15:46:05 +00:00
Dockerfile fix: Fix pip not found error during docker build 2024-04-08 18:09:59 -04:00
README.md Initialize 2024-04-05 14:54:16 -04:00
action.yml fix: Add auth token 2024-04-08 19:21:06 -04:00
entrypoint.py fix: Fix entrypoint.py to be executable 2024-04-08 18:50:50 -04:00

README.md

Generate BOM

Generate a BOM for a project on AllSpice Hub using py-allspice.

Note: currently only works with Altium projects.

Usage

Add the following step to your actions:

- name: Generate BOM
  uses: https://hub.allspice.io/shrikanth-allspice/generate-bom@v1
  with:
    project_path: Archimajor.PrjPcb
    output_file_name: bom.csv
    attributes_mapping: >
      {
        "description": ["PART DESCRIPTION"],
        "designator": ["Designator"],
        "manufacturer": ["Manufacturer", "MANUFACTURER"],
        "part_number": ["PART", "MANUFACTURER #"]
      }      
    auth_token: ${{ secrets.ALLSPICE_HUB_AUTH_TOKEN }}