====== 13.13 Script Exit Codes ======

[[fxdemo:05-part:start | Go To Top ]]

[[fxdemo:05-part:13-build-and-run-scripts:start | Return to Build and Run Scripts ]]

Scripts should use meaningful exit codes so that developers, testers, CI runners, and demonstration operators can distinguish success from failure.

The basic convention should be:

  - ''0'' for success.
  - Non-zero for failure.

The team may define additional exit-code categories if scripts or CI workflows need more detail. For example, the team may distinguish:

  - Missing prerequisites.
  - Invalid arguments.
  - [[dido:99_annexes:annex-b-terms-and-definitions:c:configuration|Configuration]] failure.
  - Generation failure.
  - Build failure.
  - Runtime failure.
  - Validation failure.
  - Unexpected internal script failure.

When a script returns non-zero, it should print a clear message explaining what failed and what the user should check next. A script should not return success if required work failed.

Exit-code conventions should appear in script headers, script help text, and the Script Reference appendix.

----

<WRAP centeralign>

© 2026 Dido Solutions, Inc. and Jackrabbit Consulting, Inc.

</WRAP>