Getting started
Adding it to CI
Make the check required, so a deploy that breaks a rule cannot go out.
Axiom is most useful when nobody has to remember to run it. Make it a required check and your pipeline does the remembering.
GitHub Actions
- name: Check rules
run: axiom check --format github
The github format writes notes against the lines that failed, so a reviewer sees the broken rule in the diff rather than in a log.
Making it required
In branch protection, add Check rules to the required checks. From then on a pull request that would break a rule cannot merge.
When you need to override
Run axiom check --override "reason". The check still runs, the override is written down with your name on it, and the owner is told. There is no quiet way around it.