Design production files generation CI job

[jaylamb]

Feature Design Add production files generation CI script (ci/generate-production-files) which will create a directory (prodcution_files) within the project repository, if it does not already exist. The directory should be the target for the KiBot script's output, which will include all project printed circuit board Gerbers, drill files, and pick-and-place files.

Feature Use Case This CI job will run automatically as a part of pull requests, releases, etc... and will produce production files (Gerbers, drills, pick and place) for all printed circuit boards contained within a project repository.

Detailed Design

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

  git submodule add ../KiBot utilities/KiBot

  Note: KiBot requires the installation of the python3-distutils package to run

• [ ] Add ci/generate-production files 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_production_files():

local kibot_config_file; kibot_config_file="$repository/kibot_config.kibot.yaml"
local output_dir; output_dir="$repository/production_files/"
local layouts; mapfile -t layouts < <( git -C "$repository" ls-files '*.kicad_pcb' | xargs -r -d '\n' -I '{}' find "$repository/{}" ); readonly layouts

for layout in "${layouts[@]}"; do
    if ! "$repository/utilities/KiBot/src/kibot" -b "$layout" -c "$kibot_config_file" -d "$output_dir"; then
        abort
    fi  
done

• [ ] Add KiBot configuration file (kibot_config.kibot.yaml) to project repository. This file specifies which production files to generate, and which directories and subdirectories to create for them:

  
  kibot:
  version: 1

preflight: check_zone_fills: false run_drc: false run_erc: false update_xml: false

global: output: '%f-%i.%x'

outputs:

• name: 'Gerbers' type: 'gerber' dir: 'gerber' options: create_gerber_job_file: true exclude_edge_layer: true exclude_pads_from_silkscreen: true force_plot_invisible_refs_vals: false gerber_precision: 4.6 line_width: 0.1 plot_footprint_refs: true plot_footprint_values: false plot_sheet_reference: false subtract_mask_from_silk: false tent_vias: false use_aux_axis_as_origin: false use_gerber_net_attributes: true use_gerber_x2_attributes: false use_protel_extensions: false layers:

  • layer: 'F.Cu'
  • layer: 'In1.Cu'
  • layer: 'In2.Cu'
  • layer: 'B.Cu'
  • layer: 'F.Paste'
  • layer: 'B.Paste'
  • layer: 'F.SilkS'
  • layer: 'B.SilkS'
  • layer: 'F.Mask'
  • layer: 'B.Mask'
  • layer: 'Edge.Cuts'

• name: 'Drill' type: 'excellon' dir: 'gerber' options: map: type: 'gerber' metric_units: true minimal_header: false mirror_y_axis: false pth_and_npth_single_file: true use_aux_axis_as_origin: false

• name: 'Pick and Place' type: 'position' dir: 'pick-and-place' options: format: 'ASCII' only_smd: true separate_files_for_front_and_back: true units: 'millimeters'

• [ ] Add production files generation (and archiving) CI job to .github/workflows/ci.yml:

  generate-production-files:
  name: Generate production files
  runs-on: ubuntu-20.04
  steps:
      - uses: actions/checkout@v2
          with:
              submodules: recursive
      - name: Generate production files
          shell: bash
          run: ./ci/generate-production-files
      - name: Archive generated production files
          uses: actions/upload-artifact@v2
          with:
              name: production-files
              path: production-files
              retention-days: 7

[apcountryman]

The design generally LGTM. A few notes:

• Splitting the local declaration and initialization of the kibot_config_file and output_dir variables isn't necessary since they don't require complex initialization.
• The kibot_config_file and output_dir variables should be read-only. As written, this could be accomplished with a trailing readonly foo. If the local declaration and initialization were combined, this could be accomplished with local -r foo=...
• The kibot_config_file and output_dir variables aren't really necessary. They just shorten the line length of the kibot invocation.
• The output directory name in the generation script does not match the name of the directory that is archived (_ vs -)
• kibot_config.kibot.yaml is slightly repetitive. kibot.yaml would be better IMO.
• The proposed KiBot configuration file assumes that a 4 layer board will be used. This will need to be revised when a test layout if the test layout is not 4 layers.

I'll open a type-feature issue for implementing this new feature shortly.