pcbjam/docker
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Gergő Törcsvári d6d743340d
refactor(build): fold calculator into unified docker/build.sh dispatch
Convert the calculator port (commit 0464470) from the parallel/copy-paste
pattern to the dispatch pattern used by pcbnew + eeschema.

- docker/build.sh: <app> is now required (no pcbnew default); missing,
  unknown, and --help paths all print "pcbnew | eeschema | calculator | all".
  Adds calculator to build_app() via kicad_subdir_for() (pcb_calculator
  inner subdir, calculator.* output basename). Also fixes the
  EMSDK=/emsdkkicad-wasm-builder typo that snuck in during the calc merge.
- scripts/kicad/build-kicad-target.sh: accepts calculator; introduces
  KICAD_TARGET (pcb_calculator for calc, == APP_NAME otherwise) used for
  the make target, embind include path, and final-log line.
- scripts/kicad/build-calculator.sh: 305-line copy of build-pcbnew.sh
  collapsed to a 7-line wrapper around build-kicad-target.sh.
- tests/scripts/setup-kicad-wasm.sh: copy_app calculator added with the
  same pcb_calculator subdir mapping for the docker-volume fallback path.
- tests/package.json: test:calculator* routed through the shared
  playwright-kicad.config.ts kicad/calculator.spec.ts (mirrors eeschema).
- Delete: docker/build-calculator.sh, tests/scripts/setup-calculator-wasm.sh,
  tests/playwright-calculator.config.ts.

Bumps wxwidgets d1d1627 -> 6fb2eac (origin/wasm-port). The new sha includes
"unic/combobox: add GetCurrentSelection() inline default" which calc's
kicad/pcb_calculator/widgets/unit_selector.cpp needs to compile. Without
this bump the unified dispatch would expose calc as a buildable target but
the build itself would fail. Verified: build.sh all completes clean across
all three apps; pcbnew/eeschema e2e pass; calc compiles and launches (test
stability separate from this refactor).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-29 16:01:18 +02:00
..
build.sh refactor(build): fold calculator into unified docker/build.sh dispatch 2026-05-29 16:01:18 +02:00
docker-compose.yml Add Quick Start docs and branch-specific Docker builds 2026-01-03 09:08:12 +01:00
Dockerfile fix(docker): add unzip to image (required by GLM dep build) 2026-05-25 19:59:15 +02:00
entrypoint.sh fix(docker): make container emsdk authoritative for exec, stop host emsdk leak 2026-05-25 19:41:55 +02:00
README.md Add Quick Start docs and branch-specific Docker builds 2026-01-03 09:08:12 +01:00
shell.sh Add Docker build environment for KiCad WASM 2025-12-08 12:07:01 +01:00

Docker Build Environment for KiCad WASM

This directory contains Docker configuration for building KiCad for WebAssembly in a reproducible, isolated environment.

Prerequisites

  • Docker Desktop (with Docker Compose v2)
  • Git submodules initialized: git submodule update --init --recursive

Quick Start

# Build KiCad WASM (full build)
./docker/build.sh

# Build with options
./docker/build.sh --no-clean    # Skip cleaning build directory
./docker/build.sh --debug       # Build with debug symbols

# Interactive shell for debugging
./docker/shell.sh

Branch-Specific Builds

Each git branch gets isolated Docker containers and volumes, enabling parallel development:

# On branch 'main' → containers/volumes prefixed with 'kicad-wasm-main'
# On branch 'feature-x' → containers/volumes prefixed with 'kicad-wasm-feature-x'

This allows you to:

  • Work on multiple branches simultaneously using git worktrees
  • Each worktree has its own build cache (no conflicts)
  • Switch branches without rebuilding from scratch

Using git worktrees for parallel development:

# Create a worktree for a new branch
git worktree add ../kicad-wasm-feature path/to/branch

# Build in the worktree (uses isolated Docker volumes)
cd ../kicad-wasm-feature
./docker/build.sh

# List all worktrees
git worktree list

What Gets Built

The build process includes:

  1. Dependencies (cached in Docker volume):

    • GLM (header-only)
    • Zstd, Protobuf
    • FreeType, HarfBuzz
    • Pixman, Cairo
    • Boost (Locale)
    • OpenCASCADE (optional, for 3D/STEP)
    • CURL headers, libgit2 headers (stubs)
  2. wxWidgets (built from submodule)

  3. KiCad PCBnew (main application)

Container Resources

Configured for M4 Max (adjust in docker-compose.yml):

  • CPUs: 10 cores
  • Memory: 16GB

Volume Strategy

Path Type Purpose
/workspace Bind mount Source code
/workspace/build-wasm Named volume Build cache (deps, sysroot)
/workspace/output Bind mount Final WASM output

Common Commands

# Start container
docker compose -f docker/docker-compose.yml up -d

# Run a command inside
docker compose -f docker/docker-compose.yml exec kicad-wasm-builder <command>

# View logs
docker compose -f docker/docker-compose.yml logs -f

# Stop container
docker compose -f docker/docker-compose.yml down

# Clear build cache (full rebuild)
docker volume rm docker_kicad-build-cache

Troubleshooting

Build freezes

The OpenCASCADE build is very resource-intensive. If it freezes:

  1. Reduce parallel jobs: Edit script to use -j4 instead of -j$(nproc)
  2. Monitor with docker stats
  3. Consider building OpenCASCADE separately with ./scripts/deps/build-opencascade.sh

Permission issues

Files created in container are owned by root. To fix:

sudo chown -R $(whoami) output/

Cache issues

# Clear all cached builds
docker volume rm docker_kicad-build-cache

# Or clear specific stamps inside container
./docker/shell.sh
rm /workspace/build-wasm/stamps/*.stamp