Documentation
¶
Overview ¶
check-runner is a parallel check execution tool for contracts-bedrock.
It reads a checks.yaml configuration file that defines phases of checks to run. Each phase can optionally require a build step, and checks within a phase run in parallel by default (with dependency support for ordering).
Key features:
- Parallel execution of independent checks within each phase
- Build caching based on source file hashes (SHA256 of all .sol files)
- Automatic artifact preservation and restoration
- Graceful shutdown on Ctrl+C (restores artifacts before exit)
- Dependency-based ordering within phases
- Pretty terminal output with spinners and colors
Usage:
go run ./scripts/check-runner -config checks.yaml go run ./scripts/check-runner -run lint,snapshots go run ./scripts/check-runner -list go run ./scripts/check-runner -no-build go run ./scripts/check-runner -clean
Click to show internal directories.
Click to hide internal directories.