Generate WireViz Template for a Multiboard Assembly

Generate a WireViz template YAML file for a multiboard assembly using AllSpice Actions. The template file includes all the connectors and their pins, but does NOT include any wires or connections.

Usage

Add the following step to your actions:

- name: Generate WireViz Template
  uses: https://hub.allspice.io/Actions/generate-wireviz-template@v0.1
  with:
    allspice_auth_token: ${{ secrets.ALLSPICE_AUTH_TOKEN }}

Important Notes

• This action generates a WireViz template YAML file based on a multiboard assembly configuration. You can then edit the template to set up the wiring connections between the boards, and use the wireviz tool to generate a visualization.
• You do not need to check out the repository for this action to work.
• An AllSpice API token is required to access the assembly configuration. You can generate a token in your AllSpice account settings and add it as a secret in your repository.

Customizing the Template Generation

1. assembly_file_path: Path to the assembly YAML file. If not specified, "assembly.yaml" at the root of the repository is used.
2. variant: Specific variant of the assembly to generate the template for. If not specified, the default variant is used.
3. output_file: Name of the output file for the generated template. If not specified, it will be saved as "wireviz.yaml" in the root.

Example with custom inputs:

- name: Generate WireViz Template
  uses: https://hub.allspice.io/Actions/generate-wireviz-template@v0.1
  with:
    allspice_auth_token: ${{ secrets.ALLSPICE_AUTH_TOKEN }}
    assembly_file_path: configs/my_assembly.yaml
    variant: Double
    output_file: my_wireviz_template.yaml

Debugging

If you encounter any issues or need more detailed information about the action's execution, you can set the log_level input to 'DEBUG' for more verbose logging:

- name: Generate WireViz Template
  uses: https://hub.allspice.io/Actions/generate-wireviz-template@v0.1
  with:
    allspice_auth_token: ${{ secrets.ALLSPICE_AUTH_TOKEN }}
    log_level: DEBUG

For more information about AllSpice Actions and how to use them in your workflows, please refer to the AllSpice Documentation.