AI_Assistant/pcbjam
Watch
1
0
Fork
You've already forked pcbjam
 0
Code Issues Pull requests Projects Releases 4 Packages Wiki Activity Actions 2
pcbjam/docker
History
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Gergő Törcsvári 80ee95a785
 build: split build.sh into --compile-only / --postprocess-only phases 
The container compile produces an OPT-INDEPENDENT base wasm; the only opt-dependent work is the final 'wasm-opt -O$LEVEL' shrink in apply-asyncify (host post-process). Splitting the build at that boundary lets CI cache the expensive compile ONCE (shared across -O1/-O2) and re-run only the asyncify/-O tail per opt level.

--compile-only: in-container compile → output/ base wasm (no post-process). --postprocess-only: pure host dyncall+finalize+asyncify+wasm-opt -O on the existing base (no container; get-wasm-opt self-provisions Binaryen). Default 'both' is unchanged. Phase flags are extracted before ARGS so they are not forwarded to inner build-<app>.sh. bash -n + shellcheck -S error clean; extraction unit-checked incl. the empty-after-filter case.

Enables the two-tier CI cache (opt-independent base + opt-specific final) so an -O2 demo release reuses main's compiled base and only runs asyncify+O2.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-22 16:23:30 +02:00
..
build.sh build: split build.sh into --compile-only / --postprocess-only phases 2026-06-22 16:23:30 +02:00
docker-compose.yml perf(build): 4h05m -> 1h15m full CI build — docker caps, pipelined wasm-opt, Binaryen 130 2026-06-11 07:48:46 +02: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

README.md

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