nerdyscout/kicad-exports

kicad-exports 镜像文档

镜像概述和主要用途

kicad-exports是一个Docker镜像，用于为KiCAD5项目自动生成导出文件，包括原理图、Gerber文件、图表等。它支持本地运行和集成到GitHub Actions工作流中，可在代码推送或拉取请求时自动执行导出任务，并包含ERC（电气规则检查）和DRC（设计规则检查）功能，确保导出文件的准确性。

核心功能和特性

• 自动生成多种导出文件：原理图、Gerber文件、图表等
• 集成ERC和DRC检查（预定义配置中），检查失败时不生成导出文件
• 支持自定义配置文件，可定义过滤规则忽略特定错误
• 提供本地运行和GitHub Actions两种使用方式
• 支持批量处理多个配置文件和bundle（配置序列）
• 本地运行提供额外参数：详细输出、配置变量覆盖、跳过预检查、PCB差异比较

使用场景和适用范围

• KiCAD5项目开发流程中自动生成生产文件或文档
• 版本控制中（如git push）自动触发导出和检查，确保设计质量
• 开发团队协作时，通过GitHub Actions自动生成并共享导出结果
• 个人开发者本地快速生成项目导出文件，提高工作效率

使用方法和配置说明

GitHub Actions集成

工作流配置示例

yaml
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@v2.3.1
      with:
        # 必需 - kibot配置文件
        config: any.kibot.yaml
        # 可选 - 输出目录前缀（在配置中定义）
        dir: docs
        # 可选 - 原理图文件
        schema: '*.sch'
        # 可选 - PCB设计文件
        board: '*.kicad_pcb'
        # 可选 - 详细输出信息
        verbose: 1
    - name: 上传结果
      uses: actions/upload-artifact@v2
      with:
        name: docs
        path: docs

配置说明

• config（必需）：kibot配置文件路径
• dir（可选）：输出目录前缀，与配置中定义的输出路径结合
• schema（可选）：原理图文件路径，默认为*.sch
• board（可选）：PCB设计文件路径，默认为*.kicad_pcb
• verbose（可选）：详细输出开关，1为启用

⚠️ 警告：将自动生成的文件手动推回正在工作的同一分支是不明智的！

本地使用

安装

需先安装Docker，然后执行以下命令：

bash
git clone --recursive https://github.com/nerdyscout/kicad-exports /some/where/kicad-exports
cd /some/where/kicad-exports
make && make install

基本运行命令

进入KiCad项目目录，运行：

bash
cd /my/kicad/example-project
kicad-exports -d $DIR_OUT -e $SCHEMA -b $BOARD -c $CONFIG 

⚠️ 警告：运行任何命令时，您的git仓库将通过https://github.com/INTI-CMNB/kicad-git-filters/tree/v1.0.1%E8%A2%AB%E4%BF%AE%E6%94%B9

运行示例

使用预定义示例配置

bash
kicad-exports -c any.kibot.yaml 

使用自定义配置

将配置文件放在KiCad项目目录中，使用相对路径：

bash
kicad-exports -c myconfig.kibot.yaml -v -s all

或运行多个配置文件：

bash
kicad-exports -c config/*.kibot.yaml -b myproject.kicad_pcb -e myproject.sch

运行bundle

bundle是一系列按顺序运行的配置：

bash
kicad-exports -c config/bundle/documentation.default.kibot.lst

生成PCB差异文件

生成指定提交与最新提交之间的PCB差异：

bash
kicad-exports -x $COMMIT_HASH -b myproject.kicad_pcb

本地运行额外参数

• -v, --verbose：详细输出，开发自定义配置文件时有用
• -o, --overwrite key=value：覆盖配置文件中的变量
• -s, --skip $arg：跳过配置文件中的预检查
• -x, --diff $commit_hash：输出指定提交与最新提交之间的差异文件

依赖项目

• https://github.com/INTI-CMNB/kibot
• https://github.com/SchrodingersGat/KiBoM
• https://github.com/openscopeproject/InteractiveHtmlBom/wiki/Usage
• https://github.com/INTI-CMNB/kicad-automation-scripts
• https://github.com/yaqwsx/PcbDraw
• https://github.com/INTI-CMNB/kicad-git-filters
• https://github.com/Gasman2014/KiCad-Diff
• https://github.com/whitequark/kicad-boardview