====== 15.5 Script Logs ======

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

[[fxdemo:05-part:15-logging-and-observability:start | Return to Logging and Observability ]]

Build, setup, generation, run, stop, validation, and Git-preparation scripts should produce diagnostic output that helps users understand script progress and failure conditions.

Script logs should record:

  - Script name.
  - Start time, where useful.
  - Working directory.
  - Selected target, profile, Node, or environment.
  - Major actions performed.
  - Tool checks and relevant tool versions.
  - Files or directories created, generated, modified, or inspected.
  - Warnings.
  - Errors.
  - Output locations.
  - Final result.

Scripts should return meaningful exit codes as defined in Section 13.13. A script should not print a successful result when a required action failed.

Script output should support both interactive use and CI logs. The output should remain readable in a terminal, but it should also give CI or validation jobs enough information to diagnose failures.

----

<WRAP centeralign>

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

</WRAP>