15.5 Script Logs

Go To Top

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:

1. Script name.
2. Start time, where useful.
3. Working directory.
4. Selected target, profile, Node, or environment.
5. Major actions performed.
6. Tool checks and relevant tool versions.
7. Files or directories created, generated, modified, or inspected.
8. Warnings.
9. Errors.
10. Output locations.
11. 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.