====== 13.14 Script Logging ======

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

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

Scripts should write output that supports developer troubleshooting, CI execution, demonstration operation, and acceptance [[dido:99_annexes:annex-b-terms-and-definitions:e:evidence|Evidence]]. Script output should explain what the script is doing without overwhelming the user with unnecessary detail.

Script logs should include:

  - Script name.
  - Start time, where useful.
  - [[dido:99_annexes:annex-b-terms-and-definitions:r:repository|Repository]] path or working directory.
  - Selected profile or target, where applicable.
  - Tool versions, where relevant.
  - Major actions performed.
  - Warnings.
  - Errors.
  - Output locations.
  - Final result.

Scripts should avoid logging secrets, tokens, passwords, private keys, or sensitive local values. If a script reads sensitive [[dido:99_annexes:annex-b-terms-and-definitions:c:configuration|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.

----

<WRAP centeralign>

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

</WRAP>