Development¶
Prerequisites¶
- Crystal 1.10+
- Shards
- Make
Build¶
make deps
make build # debug binary
make release # optimized binary
make static # static binary (Linux/musl)
Test¶
Quality¶
Docker¶
Documentation¶
Preview the docs site locally:
This starts a dev server at http://127.0.0.1:8000/autobot/ with live reload — any changes to docs/ or mkdocs.yml are reflected immediately.
Releasing¶
- Bump
versioninshard.ymland merge that change intomain. - Tag the merged commit with the same version (
git tag v0.9.1 && git push origin v0.9.1).
The release workflow refuses to build when the tag does not match shard.yml. Autobot::VERSION is compiled from shard.yml, so a stale manifest ships binaries that report the previous version.