Skip to content

Commit 1fa5b19

Browse files
FloWuenneclaude
andauthored
📝 docs(agents): document ARM64 (Apple Silicon) testing workflow (#146)
All containers are linux/amd64 only; they run via QEMU emulation on ARM Macs. Add a dedicated section explaining the `arm` profile and when to use it to avoid Docker platform-mismatch warnings. Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent 703f526 commit 1fa5b19

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,25 @@ uv run --with typer --with pyyaml \
8888
- **nf-test (pipeline integration tests):** `nf-test test --profile=+docker --verbose`
8989
- **Lint:** `pre-commit run --all-files`
9090

91+
### Running on Apple Silicon (ARM64)
92+
93+
All pipeline containers are `linux/amd64` only (the Wave community image has no ARM64 variant). On ARM Macs, Docker runs these via QEMU/Rosetta emulation — tests and the pipeline work without any changes.
94+
95+
For explicit x86_64 emulation (recommended on ARM Macs to avoid Docker platform-mismatch warnings), combine the `arm` profile with `docker`:
96+
97+
```bash
98+
# nf-test
99+
nf-test test --profile=+docker,+arm --verbose
100+
101+
# direct nextflow run
102+
nextflow run . --input workflows/nf_aggregate/assets/test_benchmark.csv \
103+
--generate_benchmark_report --outdir results -profile docker,arm
104+
```
105+
106+
The `arm` profile adds `--platform=linux/amd64` to Docker run options so the container engine picks the correct image manifest instead of silently falling back.
107+
108+
Python unit tests (`pytest`) run natively on ARM — no `arm` profile needed for those.
109+
91110
### Agent quick verify (offline)
92111

93112
Run this exact sequence when validating split benchmark-report changes in Cursor Cloud:

0 commit comments

Comments
 (0)