Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ci/yaml/script.md')
-rw-r--r--doc/ci/yaml/script.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/ci/yaml/script.md b/doc/ci/yaml/script.md
index 71b9e9fbe0b..016b0ae9482 100644
--- a/doc/ci/yaml/script.md
+++ b/doc/ci/yaml/script.md
@@ -340,3 +340,16 @@ Resolve this by either:
"Authorization: Bearer $CI_JOB_TOKEN" \
"${CI_API_V4_URL}/job")
```
+
+### Job log output is not formatted as expected or contains unexpected characters
+
+Sometimes the formatting in the job log displays incorrectly with tools that rely
+on the `TERM` environment variable for coloring or formatting. For example, with the `mypy` command:
+
+![Example output](img/incorrect_log_rendering.png)
+
+GitLab Runner runs the container's shell in non-interactive mode, so the shell's `TERM`
+environment variable is set to `dumb`. To fix the formatting for these tools, you can:
+
+- Add an additional script line to set `TERM=ansi` in the shell's environment before running the command.
+- Add a `TERM` [CI/CD variable](../variables/index.md) with a value of `ansi`.