Back
Advanced // Project Rules & Reports
Project Rules & Reports
Docs › Advanced › Project Rules & Reports
Project Rules & Reports
Give your project rules that apply to every change, whether it's made by a person, by NOVA or by another tool. Four quick reports tell you where things stand. They don't need sign-in or AI, so they're great for CI.
Create a rules file
bash
nova init
This creates .nova/policy.yml in your project. Edit it, then commit it so your team shares the rules:
.nova/policy.yml
version: 1 protected_paths: - .github/workflows/** - migrations/** protected_branches: - main - release/* required_checks: - test - lint approval_required_for: - git push - dependency install
protected_paths: changes here need a person's approval.
protected_branches: publishing to these needs its own approval.
required_checks: checks that must pass.
approval_required_for: actions that always stop for review.
You can also add
allowed_dependencies, a list of packages NOVA may install, such as npm:react or pip:requests.The four reports
bash
nova brief # a quick map: branch, stack, commands, what's changed
nova verify # run the checks your changes need, and explain the result
nova risk # what a reviewer should look at first
nova handoff # a summary of the changes and their checks
nova verify # run the checks your changes need, and explain the result
nova risk # what a reviewer should look at first
nova handoff # a summary of the changes and their checks
Add --json to any of them for machine-readable output.
Exit codes for reports
| Code | Meaning |
|---|---|
| 0 | Everything required passed |
| 1 | A required check failed or never ran |
| 2 | Blocked: a person needs to approve |
| 3 | NOVA doesn't recognise this as a project it can check |
Join our Discord
Chat with our engineers and become part of the active NOVA developer community.
Need help?
Open an issue on GitHub or email support@bridgeye.com.