Design schematic PDF generation CI job

[jaylamb]

Feature Design

• [ ] Add schematic PDF generation CI script (ci/generate-schematic-pdf) which will create a directory (schematic-pdfs) within the project repository. The directory should be the target for the KiAuto eeschema_do script's export function, which should generate PDFs for any schematic sheets belonging to the project.
• [ ] Each PDF should be generated as a GitHub artifact with a retention period of seven days.

Feature Use Case

This CI job will run automatically as a part of pull requests, releases, etc... and will ensure that PDF versions of all schematic sheets are available for use by users/reviewers.

Detailed Design

• [ ] Add ci/generate-schematic-pdf 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_schematic_pdf():

    
    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" export -a "$schematic" "$repository/schematic-pdfs"; then abort fi done

- [ ] Add schematic PDF exporting and PDF artifact generation to `.github/workflows/ci.yml`:
```yaml
generate-schematic-pdf:
    name: Generate schematic PDF(s)
    runs-on: ubuntu-20.04
    steps:
        - uses: actions/checkout@v2
          with:
              submodules: recursive
        - name: Generate schematic PDF(s)
          shell: bash
          run: ./ci/generate-schematic-pdf
        - name: Archive production artifacts
          uses: actions/upload-artifact@v2
          with:
            name: upload-schematics
            path: |
              schematic-pdfs
            retention-days: 7

[apcountryman]

The schematic PDF generation script looks good to me. Consider changing "$repository/deliverables" to "$repository/schematic-pdfs" since the directory will only contain schematic PDFs.

Please add the required .github/workflow/ci.yml updates to the design. I think it would be a good idea to store the generated schematic PDFs as workflow artifacts to make a PR reviewer's job easier. 7 days seems like it would be a reasonable artifact retention period. More information about storing workflow data as artifacts can be found at https://docs.github.com/en/actions/guides/storing-workflow-data-as-artifacts.

[apcountryman]

A few things:

• The CI script name should probably be changed to ci/generate-schematic-pdfs, and the workflow job name should probably be changed to generate-schematic-pdfs for consistency with other verbage
• I think Archive generated schematic PDF(s) would be a more descriptive job step name than Archive production artifacts
• I think schematic-pdfs would be a more descriptive artifact name than upload-schematics
• I believe the | is not necessary for a single line path and thus that entry (?) could be changed to path: schematic-pdfs

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