runnerd-core 0.1.3

Config, domain logic and API types shared by runnerd and its clients
Documentation

runnerd

CI Release crates.io MSRV License: MIT Docs

runnerd runs ephemeral GitHub Actions runners on one Linux host: a fresh container per job, sized from what the repositories you serve have used.

Install

curl -fsSL https://github.com/ayagmar/runnerd/releases/latest/download/install.sh | sh
runnerd init halyard/ledger halyard/storefront

init writes a config sized for the host and a systemd user unit, runs runnerd doctor and prints the steps left. It never runs anything as root; the slice and Sysbox commands it prints are yours to run. Then:

systemctl --user daemon-reload
systemctl --user enable --now runnerd
runnerctl status

Point a job at the host with runs-on: [self-hosted, linux, x64]. Serve private repositories only: on a public one, anyone who opens a pull request can run code on this host.

Requirements

  • Linux with cgroup v2, and Docker with the systemd cgroup driver.
  • Sysbox and a systemd slice whose MemoryMax is the runners' budget.
  • The GitHub CLI, logged in with the repo scope.

Binaries ship for x86_64 and aarch64; the runner images are linux/amd64 only, so on aarch64 build the base stage of image/Dockerfile on the host.

Documentation

Full docs: https://ayagmar.github.io/runnerd/. Install covers pinned versions and attestation checks, Configuration every key, Why is my job waiting? every reason a job gives, and Security model what jobs, the token and the dashboard can reach. ARCHITECTURE.md says where the code lives, docs/adr why, and CONTRIBUTING.md how to send a change.

Building

cargo build --release

Run "The gate" in AGENTS.md before sending a change. Tests that start real containers are ignored by default and need Docker with Sysbox and the images:

docker build --target jvm -t runnerd-runner:jvm image
docker build --target base -t runnerd-runner:base image
cargo test -p runnerd-core --test docker_smoke --test cache_reseed --test slot_docker_store -- --ignored

The Gradle build cache test also needs the network:

cargo test -p runnerd-core --test build_cache_gradle -- --ignored
docker rmi runnerd-test-build-cache

License

MIT