You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
kicad-exports
v0.1
Pre-release
This project aims to auto generate several files (gerbers, documentation, pictures, ...) for kicad projects. You could run it locally or on every git push
with Github actions.
./kicad-exports $COMMAND $DIR $SCHMATIC $BOARD $PROJECT $MANUFACTURER $PARAMETERS
run kicad-exports as individual step, as cmd
several functions are defined.
name: example
on:
push:
paths:
- '**.sch'
- '**.kicad_pcb'
pull_request:
paths:
- '**.sch'
- '**.kicad_pcb'
jobs:
example:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: nerdyscout/kicad-exports@master
with:
# Required - command to run
cmd: command to run on kicad files
# optional - output directory
dir: example
# optional - schematic file
schematic: test-project.sch
# optional - PCB design file
board: test-project.kicad_pcb
# optional - project name
project: test-project.pro
# optional - choose one PCB manufacturer
manufacturer: "jlcpcb", "oshpark"
# optional - additional parameters
parameters: ""
- name: upload results
uses: actions/upload-artifact@v2
with:
name: example
path: example
For examples of more full workflows see kicad-exports-test.
git clone github.com/nerdyscout/kicad-exports /some/where/kicad-exports
cd /some/where/kicad-exports
make build
go to your KiCad project folder and run kicad-exports.sh
cd /my/kicad/project
./some/where/kicad-exports/kicad-exports.sh *$COMMAND*
$COMMAND can be anything running within the container, e.g.
./some/where/kicad-exports/kicad-exports.sh "eeschema_do export -f pdf $SCHEMATIC $DIR"
./some/where/kicad-exports/kicad-exports.sh kicad-schematic-pdf
both lines do the same as there are several aliases defined, checkout the functions.sh