Actions

.github/workflows/build-prod-files.yml

@@ -0,0 +1,160 @@
+name: Build production files
+
+on:
+  workflow_dispatch:
+    inputs:
+      name:
+        description: "Name of the folder containing the PCB files. The generated production files will be at 'release/<name>'."
+        required: true
+        type: string
+      overwrite:
+        description: "Overwrite existing production files for this board"
+        required: false
+        type: boolean
+        default: false
+      erc:
+        description: "Include ERC output"
+        required: false
+        type: boolean
+        default: false
+      drc:
+        description: "Include DRC output"
+        required: false
+        type: boolean
+        default: false
+      sch_file:
+        description: "Main .kicad_sch file name, defaults to '<name>.kicad_sch'"
+        required: false
+        type: string
+      pcb_file:
+        description: "Main .kicad_pcb file name, defaults to '<name>.kicad_pcb'"
+        required: false
+        type: string
+      version:
+        description: "Version number to include in info file"
+        required: false
+        type: string
+        default: "v1.0"
+      fabrication:
+        description: "Manufacturer/fabrication provider name to include in info file"
+        required: false
+        type: string
+      n_layers:
+        description: "Number of layers to include in info file (note, gerbers are generated for every layer regardless of this setting)"
+        required: false
+        type: number
+
+permissions:
+  contents: read
+
+defaults:
+  run:
+    shell: "bash"
+
+jobs:
+  init:
+    name: Initialise directory in release/ folder and check files exist
+    runs-on: ubuntu-24.04
+
+    outputs:
+      release_dir: ${{ steps.format.outputs.release_dir }}
+      sch_location: ${{ steps.format.outputs.sch_location }}
+      pcb_location: ${{ steps.format.outputs.pcb_location }}
+
+    steps:
+      - name: Checkout to latest commit
+        uses: actions/checkout@v4
+
+      - name: Format names
+        id: format
+        env:
+          NAME: ${{ inputs.name }}
+          SCH_FILE: ${{ inputs.sch_file }}
+          PCB_FILE: ${{ inputs.pcb_file }}
+        run: |
+          echo "release_dir=release/${NAME}" >> "$GITHUB_OUTPUT"
+          echo "sch_location=${NAME}/${SCH_FILE:-${NAME}.kicad_sch}" >> "$GITHUB_OUTPUT"
+          echo "pcb_location=${NAME}/${PCB_FILE:-${NAME}.kicad_pcb}" >> "$GITHUB_OUTPUT"
+
+      - name: Check schematic exists
+        env:
+          SCH_LOCATION: ${{ steps.format.outputs.sch_location }}
+        run: test -f "$SCH_LOCATION"
+
+      - name: Check PCB exists
+        env:
+          PCB_LOCATION: ${{ steps.format.outputs.pcb_location }}
+        run: test -f "$PCB_LOCATION"
+
+      - name: Check for existing release directory
+        if: inputs.overwrite == 'false' || inputs.overwrite == false
+        env:
+          RELEASE_DIR: ${{ steps.format.outputs.release_dir }}
+        run: test ! -e "$RELEASE_DIR"
+
+      - name: Setup release directory
+        env:
+          RELEASE_DIR: ${{ steps.format.outputs.release_dir }}
+        run: |
+          rm -rf "$RELEASE_DIR"
+          mkdir -p "$RELEASE_DIR"
+
+  gen_files:
+    name: Generate gerbers, schematic PDF and interactive BOM
+    runs-on: ubuntu-24.04
+    needs: init
+
+    permissions:
+      contents: write
+
+    container:
+      image: maartin0/kicadutils
+
+    steps:
+      - name: Checkout to latest commit
+        uses: actions/checkout@v4
+
+      - name: Add version to info
+        if: inputs.version != ''
+        env:
+          RELEASE_DIR: ${{ needs.init.outputs.release_dir }}
+          VERSION: ${{ inputs.version }}
+        run: echo "version=${VERSION}" >> "${RELEASE_DIR}/info"
+
+      - name: Add fabrication to info
+        if: inputs.fabrication != ''
+        env:
+          RELEASE_DIR: ${{ needs.init.outputs.release_dir }}
+          FABRICATION: ${{ inputs.fabrication }}
+        run: echo "fabrication=${FABRICATION}" >> "${RELEASE_DIR}/info"
+
+      - name: Add layers to info
+        if: inputs.n_layers != ''
+        env:
+          RELEASE_DIR: ${{ needs.init.outputs.release_dir }}
+          LAYERS: ${{ inputs.n_layers }}
+        run: echo "layers=${LAYERS}" >> "${RELEASE_DIR}/info"
+
+      - name: Generate files
+        env:
+          RELEASE_DIR: ${{ needs.init.outputs.release_dir }}
+          SCH_LOCATION: ${{ needs.init.outputs.sch_location }}
+          PCB_LOCATION: ${{ needs.init.outputs.pcb_location }}
+          RUN_ERC: ${{ inputs.erc }}
+          RUN_DRC: ${{ inputs.drc }}
+        run: |
+          ARGS=""
+          [ "$RUN_ERC" = "true" ] && ARGS="--erc"
+          [ "$RUN_DRC" = "true" ] && ARGS="$ARGS --drc"
+          ./bin/gen.sh "$SCH_LOCATION" "$PCB_LOCATION" "$RELEASE_DIR" $ARGS
+
+      - name: Commit changes
+        env:
+          NAME: ${{ inputs.name }}
+        run: |
+          git config --global user.name 'github-actions'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git config --global --add safe.directory "$(pwd)"
+          git add release/
+          git commit -m "Automatically generate $NAME production files"
+          git push

.github/workflows/test-all.yml

@@ -0,0 +1,39 @@
+name: Test all projects
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+defaults:
+  run:
+    shell: "bash" # We're using the bash-specific set -o pipefail
+
+jobs:
+  test_erc_drc:
+    name: Run KiCad ERC(s) and DRC(s)
+    runs-on: ubuntu-24.04
+    container:
+      image: maartin0/kicadutils
+
+    steps:
+      - name: Checkout to latest commit
+        uses: actions/checkout@v4
+
+      - name: Run ERC(s)
+        run: find . -name "*.kicad_sch" -print0 | xargs -0 -n1 sh -c './bin/test/erc.sh "$0" || exit 255'
+
+      - name: Run DRC(s)
+        run: find . -name "*.kicad_pcb" -print0 | xargs -0 -n1 sh -c './bin/test/drc.sh "$0" || exit 255'
+
+  test_relative:
+    name: Check for non-relative paths
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Check for non-relative paths
+        run: find . -name "*-lib-table" -print0 | xargs -0 -n1 sh -c './bin/test/relative.sh "$0" || exit 255'

.github/workflows/test-changes.yml

@@ -0,0 +1,76 @@
+name: Test changed files
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+defaults:
+  run:
+    shell: "bash"
+
+jobs:
+  changes:
+    name: Get changed files
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout to latest commit
+        uses: actions/checkout@v4
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v45
+
+    outputs:
+      changed: ${{ steps.changed-files.outputs.any_changed }}
+      all_changed_files: ${{ steps.changed-files.outputs.all_changed_files }}
+
+  test_erc_drc:
+    name: Run KiCad ERC(s) and DRC(s)
+    runs-on: ubuntu-24.04
+    needs: changes
+    if: needs.changes.outputs.changed == 'true'
+    container:
+      image: maartin0/kicadutils
+
+    steps:
+      - name: Checkout to latest commit
+        uses: actions/checkout@v4
+
+      - name: Run ERC(s)
+        env:
+          ALL_CHANGED_FILES: ${{ needs.changes.outputs.all_changed_files }}
+        run: |
+          for file in "${ALL_CHANGED_FILES}"; do
+            if echo "$file" | grep ".kicad_sch$" >/dev/null; then
+              ./bin/test/erc.sh "$file"
+            fi
+          done
+
+      - name: Run DRC(s)
+        env:
+          ALL_CHANGED_FILES: ${{ needs.changes.outputs.all_changed_files }}
+        run: |
+          for file in "${ALL_CHANGED_FILES}"; do
+            if echo "$file" | grep ".kicad_pcb$" >/dev/null; then
+              ./bin/test/drc.sh "$file"
+            fi
+          done
+
+  test_relative:
+    name: Check for non-relative paths
+    runs-on: ubuntu-24.04
+    needs: changes
+    if: needs.changes.outputs.changed == 'true'
+
+    steps:
+      - name: Check for non-relative paths
+        env:
+          ALL_CHANGED_FILES: ${{ needs.changes.outputs.all_changed_files }}
+        run: |
+          for file in "${ALL_CHANGED_FILES}"; do
+            if echo "$file" | grep "\-lib-table$" >/dev/null; then
+              ./bin/test/relative.sh "$file"
+            fi
+          done

bin/docker/Dockerfile

@@ -0,0 +1,8 @@
+FROM ubuntu:24.04
+
+RUN apt-get update &&\
+ apt-get install -y software-properties-common zip unzip python3 python3-pip nodejs npm git &&\
+ add-apt-repository -y ppa:kicad/kicad-9.0-releases &&\
+ apt-get update &&\
+ apt-get install -y kicad &&\
+ python3 -m pip install InteractiveHtmlBom --break-system-packages

bin/docker/build.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+set -e
+
+if ! [ -f "Dockerfile" ]; then
+    echo "Error: Make sure you're running this in the same directory as the Dockerfile"
+    exit 1
+fi
+
+if [ "$#" -ne 1 ]; then
+    echo "Usage: $0 <username>/<package name>"
+    exit 1
+fi
+
+docker build -t "$1" .
+docker push "$1"

bin/gen.sh

@@ -0,0 +1,64 @@
+#!/bin/sh
+
+set -e
+
+tmp_dir="$(date +"tmp-%Y.%m.%d-%H.%M.%S")"
+
+cleanup() {
+    rm -rf "$tmp_dir"
+}
+
+die() {
+    echo "$*"
+    cleanup
+    exit 1
+}
+
+if [ $# -lt 3 ]; then
+    die "Usage: $0 <sch> <pcb> <release dir> [--erc] [--drc]"
+fi
+
+sch="$1"
+shift
+test -f "$sch" || die "Schematic '$sch doesn't exist"
+pcb="$1"
+shift
+test -f "$pcb" || die "PCB '$pcb' doesn't exist"
+release_dir="$1"
+shift
+test -e "$release_dir" || die "Release dir '$release_dir' doesn't exist"
+
+while test $# -gt 0
+do
+    case "$1" in
+        --erc) RUN_ERC=1
+            ;;
+        --drc) RUN_DRC=1
+            ;;
+        *) die "Unreconised option $1"
+            ;;
+    esac
+    shift
+done
+
+mkdir -p "$tmp_dir"
+cd "$tmp_dir"
+
+# generate gerbers
+echo "../$pcb"
+kicad-cli pcb export gerbers "../$pcb"
+zip -r fabrication.zip ./*
+mv fabrication.zip "../$release_dir"
+#
+cd ..
+cleanup
+#
+INTERACTIVE_HTML_BOM_NO_DISPLAY=1 generate_interactive_bom "$pcb" --dest-dir "../$release_dir" --no-browser
+kicad-cli sch export pdf --output "$release_dir/schematic.pdf" "$sch"
+
+# gen erc-errors and drc-errors
+
+set +e # Don't abort if ERC/DRC fails
+[ "$RUN_ERC" = "1" ] && LOG_LOCATION="$release_dir/$(date +"erc-log-%Y.%m.%d-%H.%M.%S.txt")" ./bin/test/erc.sh "$sch"
+[ "$RUN_DRC" = "1" ] && LOG_LOCATION="$release_dir/$(date +"drc-log-%Y.%m.%d-%H.%M.%S.txt")" ./bin/test/drc.sh "$pcb"
+set -e