13.14 Script Logging

Go To Top

Return to Build and Run Scripts

Scripts should write output that supports developer troubleshooting, CI execution, demonstration operation, and acceptance Evidence. Script output should explain what the script is doing without overwhelming the user with unnecessary detail.

Script logs should include:

1. Script name.
2. Start time, where useful.
3. Repository path or working directory.
4. Selected profile or target, where applicable.
5. Tool versions, where relevant.
6. Major actions performed.
7. Warnings.
8. Errors.
9. Output locations.
10. Final result.

Scripts should avoid logging secrets, tokens, passwords, private keys, or sensitive local values. If a script reads sensitive Configuration, it should mask or omit sensitive values from output.

Build and run scripts shall follow the file header and inline documentation conventions defined in Section 7.10. Each script shall include a header that explains its purpose, expected working directory, required inputs, generated or modified outputs, exit-code behavior, and any dependencies on tools, environment variables, or Repository paths.