kicad render action

This action allows you to automatically render Images of your PCB and use them e.g. in a README.md

current state

This is using Kicad nightly since there is yet no Kicad release containing the image rendering command in the CLI.

Usage

Create the directory .github/workflows if it does not already exist.
Add a new yaml in that directory e.g. pcb_image.yaml

Adding the configuration. Set the path to your .kicad_pcb file (you may need to replace 'refs/heads/main' with 'refs/heads/master' on older repos)

name: pcb_image
on:
  push:
jobs:
  render-image:
    name: render-image
    runs-on: ubuntu-latest
    steps:
      - name: Check out the repo
        uses: actions/checkout@v4

      - name: render pcb image
        uses: linalinn/kicad-render@main
        with:
          pcb_file: <path from repo root to .kicad_pcb>
          output_path: ${{ github.workspace }}/images
        
      - name: Setup Pages
        if: github.ref == 'refs/heads/main'
        uses: actions/configure-pages@v3

      - name: Upload Artifact
        if: github.ref == 'refs/heads/main'
        uses: actions/upload-pages-artifact@v1
        with:
          path: "images"

  deploy-pages:
    if: github.ref == 'refs/heads/main'
    runs-on: ubuntu-latest
    needs: render-image
      
    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2

Adding the images to an README.md

# My first PCB with automatic image generation

### Images
![top](<github_username>.github.io/<repo_name>/top.png)
![bottom](<github_username>.github.io/<repo_name>/bottom.png)

Prepare the repo
- Open your repo on GitHub
- Open Setting
- (Left side) Click on Pages
- Under Build and deployment select for Source Github Action from the dropdown.
git commit and push

Rendering Animations

This Action can also render an Animation of you pcb rotating as gif or mp4 is can be enabled by adding animation: gif or animation: mp4

- name: render pcb image
  uses: linalinn/kicad-render@main
  with:
    pcb_file: <path from repo root to .kicad_pcb>
    output_path: ${{ github.workspace }}/images
    animation: gif

To display the animation in a README.md add the following to you README.md.
Note: GitHubs CDN has a file size limit this is why the animation can't be bigger then 300x300px

![animation](<github_username>.github.io/<repo_name>/rotating.gif)

Example

You can find a example here in the m2sdr and the workflow for it here

Animation original code

The code for the Animation is from arturo182
Mastdon post with Gif and link to gist

Development

In this repo, you find an .devcontainer folder. This is for making Development and testing easier by not having to install kicad-nightly on your system. Dev containers are supported by Visual Studio Code, JetBrains, and Github. Alternatively, you can run the following docker command in the repository root docker run -v "$(pwd)":/pwd --workdir=/pwd --rm -it ghcr.io/linalinn/kicad:nightly-2024-04-09-13-16 bash and run kicad nightly from inside this container.

linalinn / kicad-render