2fa4314 docs(README.md): document exit codes — radicle-native-ci

Radicle CI adapter for native CI

docs(README.md): document exit codes

Lars Wirzenius committed 1 year ago

commit 2fa4314e65eb329e6a4c74f4529f3c6b779e91f0
parent d9c49306622e4fc1c0d4ed92833407686c2412af

1 file changed +14 -0

modified README.md

@@ -57,6 +57,20 @@ The fields are:

 * `log` --- required, file where native CI should write a log
 ## Exit codes
 The `radicle-native-ci` executable uses the following exit codes:
 * 0 = success, everything went well.
 * 1 = failure, the CI run finished, but failed
 * 2 = error, the CI run could not be finished
 An example of a failure is when the CI run builds software that has a
 syntax error.
 An example of an error is when the adapter configuration file is
 missing.
 ## Packaging
 There is simple, simplistic, rudimentary, personal-use-only packaging