Skip to content

docs: sketch the exit-code contract #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Herricka wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: sketch the exit-code contract #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/exit-codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Exit-code contract (sketch)

| Code | Meaning | Caller should |
|---|---|---|
| 0 | gate passed | ship it |
| 1 | gate failed on findings | look at the report |
| 2 | policy failed to parse | fix the config, do not retry |
| 3 | input unreadable | fix the path |

## Open questions

- Should 2 and 3 collapse into one, or stay apart for CI dashboards?
- Do we ever need a distinct code for "passed with warnings"?
Loading