1name: KiCAD
2
3
4on:
5 pull_request:
6 branches: [ "main" ]
7 paths:
8 - ".github/workflows/kicad.yml"
9 - "kicad/**"
10 types:
11 - opened
12 - synchronize
13
14
15env:
16 KICAD10_3DMODEL_DIR: "./3dmodels"
17
18jobs:
19 verify-project:
20 name: Verify KiCAD Project
21 permissions:
22 contents: read
23 runs-on: ubuntu-latest
24 strategy:
25 matrix:
26 project: [ "encoder", "line", "mainboard" ]
27
28 steps:
29 - name: Checkout
30 uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 #v7.0.1
31
32 - name: Install KiCad 3D Models
33 run: |
34 sudo apt-get update
35 sudo apt-get install -y --no-install-recommends kicad-packages3d
36 sudo mv /usr/share/kicad/3dmodels ./3dmodels
37
38 - name: Verify Rules
39 uses: actions-for-kicad/kicad-actions@a9f126ff27df502685a1f0048f45b48e0dd04838 #v2.5-k10.0.5
40 with:
41 project_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pro"
42 schematic_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_sch"
43 pcb_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pcb"
44
45 footprint_libraries: "dolphin=kicad/library/footprints"
46 symbol_libraries: "dolphin=kicad/library/symbols/dolphin.kicad_sym"
47
48 run_erc: true
49 run_drc: true
50
51 - name: ERC Report
52 if: always()
53 run: |
54 if [ -f erc.rpt ]; then
55 cat erc.rpt
56 fi
57
58 - name: DRC Report
59 if: always()
60 run: |
61 if [ -f drc.rpt ]; then
62 cat drc.rpt
63 fi
64
65 - name: Export BOM CSV
66 uses: actions-for-kicad/kicad-actions@a9f126ff27df502685a1f0048f45b48e0dd04838 #v2.5-k10.0.5
67 with:
68 project_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pro"
69 schematic_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_sch"
70
71 symbol_libraries: "dolphin=kicad/library/symbols/dolphin.kicad_sym"
72
73 schematic_output_bom_fields: "${DNP},${QUANTITY},Reference,Value,Footprint,Datasheet"
74 schematic_output_bom_labels: "DNP,QTY,REF,value,footprint,datasheet"
75 schematic_output_bom_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.csv"
76 schematic_output_bom: true
77
78 - name: Export SCH PDF
79 uses: actions-for-kicad/kicad-actions@a9f126ff27df502685a1f0048f45b48e0dd04838 #v2.5-k10.0.5
80 with:
81 project_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pro"
82 schematic_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_sch"
83
84 symbol_libraries: "dolphin=kicad/library/symbols/dolphin.kicad_sym"
85
86 schematic_output_pdf_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.pdf"
87 schematic_output_pdf: true
88
89 - name: Copy SCH PDF to docs
90 run: |
91 cp kicad/projects/${{ matrix.project }}/${{ matrix.project }}.pdf docs/source/_static/pdf/${{ matrix.project }}.pdf
92
93 - name: Export PCB STEP
94 uses: actions-for-kicad/kicad-actions@a9f126ff27df502685a1f0048f45b48e0dd04838 #v2.5-k10.0.5
95 with:
96 project_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pro"
97 pcb_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pcb"
98
99 footprint_libraries: "dolphin=kicad/library/footprints"
100
101 pcb_output_step_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.step"
102 pcb_output_step: true
103
104 - name: Export PCB Image Top
105 uses: actions-for-kicad/kicad-actions@a9f126ff27df502685a1f0048f45b48e0dd04838 #v2.5-k10.0.5
106 with:
107 project_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pro"
108 pcb_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pcb"
109
110 footprint_libraries: "dolphin=kicad/library/footprints"
111
112 pcb_output_image_file_name: "kicad/projects/${{ matrix.project }}/images/${{ matrix.project }}_top.png"
113 pcb_output_image_side: "top"
114 pcb_output_image_background: "transparent"
115 pcb_output_image_width: 1920
116 pcb_output_image_floor: false
117 pcb_output_image_perspective: false
118 pcb_output_image_zoom: "1.0"
119 pcb_output_image_quality: "basic"
120 pcb_output_image_rotate: "0,0,0"
121 pcb_output_image: true
122
123 - name: Export PCB Image Bottom
124 uses: actions-for-kicad/kicad-actions@a9f126ff27df502685a1f0048f45b48e0dd04838 #v2.5-k10.0.5
125 with:
126 project_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pro"
127 pcb_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pcb"
128
129 footprint_libraries: "dolphin=kicad/library/footprints"
130
131 pcb_output_image_file_name: "kicad/projects/${{ matrix.project }}/images/${{ matrix.project }}_bottom.png"
132 pcb_output_image_side: "bottom"
133 pcb_output_image_background: "transparent"
134 pcb_output_image_width: 1920
135 pcb_output_image_floor: false
136 pcb_output_image_perspective: false
137 pcb_output_image_zoom: "1.0"
138 pcb_output_image_quality: "basic"
139 pcb_output_image_rotate: "0,0,0"
140 pcb_output_image: true
141
142 - name: Export Gerbers and Drill Files
143 uses: actions-for-kicad/kicad-actions@a9f126ff27df502685a1f0048f45b48e0dd04838 #v2.5-k10.0.5
144 with:
145 project_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pro"
146 pcb_file_name: "kicad/projects/${{ matrix.project }}/${{ matrix.project }}.kicad_pcb"
147
148 pcb_output_gerbers_and_drill_folder_name: "kicad/projects/${{ matrix.project }}/gerbers"
149 pcb_output_gerbers_and_drill: true
150
151 - name: Zip Gerbers and Drill Files
152 run: |
153 sudo zip -j kicad/projects/${{ matrix.project }}/${{ matrix.project }}.zip kicad/projects/${{ matrix.project }}/gerbers/*
154
155 - name: Upload Artifacts
156 uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 #v7.0.2
157 with:
158 name: artifacts-${{ matrix.project }}
159 path: |
160 **/docs/source/_static/pdf/${{ matrix.project }}.pdf
161 **/kicad/projects/${{ matrix.project }}/${{ matrix.project }}.csv
162 **/kicad/projects/${{ matrix.project }}/${{ matrix.project }}.pdf
163 **/kicad/projects/${{ matrix.project }}/${{ matrix.project }}.step
164 **/kicad/projects/${{ matrix.project }}/${{ matrix.project }}.zip
165 **/kicad/projects/${{ matrix.project }}/images/*.png
166
167
168 auto-commit:
169 name: Auto Commit Modified Files
170 needs:
171 - verify-project
172 permissions:
173 contents: write
174 runs-on: ubuntu-latest
175
176 steps:
177 - name: Checkout
178 uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 #v7.0.1
179 with:
180 ref: ${{ github.head_ref || github.ref_name }}
181 persist-credentials: true
182
183 - name: Download Artifacts
184 uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 #v8.0.2
185 with:
186 pattern: "artifacts-*"
187 merge-multiple: true
188 path: .
189
190 - name: Auto Commit
191 uses: stefanzweifel/git-auto-commit-action@d0b01107b5db882071f96de5dd4b54961ea93f4c #v7.2.1
192 with:
193 commit_message: "chore(ci): update generated KiCAD files [skip ci]"
194 file_pattern: 'docs/source/_static/pdf/*.pdf kicad/**/*.csv kicad/**/*.pdf kicad/**/*.png kicad/**/*.step kicad/**/*.zip'