Skip to content

Commit 40267a5

Browse files
committed
gitlab-ci: List defaults for empty value variables
Make it easier for user to know the default values for variables instead of having to find them in `scripts/set-defaults.sh`. Signed-off-by: Thomas Steenbergen <[email protected]>
1 parent 20f8eaf commit 40267a5

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

.gitlab-ci.yml

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,39 +53,53 @@ variables:
5353
git, mercurial or subversion)
5454
ORT_CONFIG_FILE:
5555
value: ""
56-
description: "Path to repository configuration file relative to the VCS root. If empty '.ort.yml' is used as default."
56+
description: |
57+
Path to repository configuration file relative to the VCS root.
58+
By default set to '.ort.yml'.
5759
ORT_ALLOW_DYNAMIC_VERSIONS:
5860
value: ""
5961
description: |
6062
Set to 'true' only if dynamic dependency versions are allowed (note version ranges specified for dependencies may cause unstable results).
6163
This field applies only to package managers that support lock files, e.g. NPM.
64+
By default set to 'false'.
6265
DISABLE_SHALLOW_CLONE:
6366
value: ""
6467
description: |
6568
If set to 'true', the full history of the project is cloned. This option works only if VCS_TYPE is 'git'.
66-
Check this option only if you know that it is required for your scan.
69+
Check this option only if you know that it is required for your scan. By default set to 'false'.
6770
FAIL_ON_OUTDATED_NOTICE_FILE:
6871
value: "false"
6972
description: "If set to 'true', the scan will be considered as failed if generated NOTICE file differs from the one in your repository."
7073
NOTICE_FILE:
7174
value: ""
72-
description: "Path to open source attribution document relative to the VCS root. If empty 'FOSS_NOTICE' is used as default."
75+
description: |
76+
Path to open source attribution document relative to the VCS root.
77+
By default set to 'FOSS_NOTICE'.
7378
ORT_CONFIG_REVISION:
7479
value: ""
7580
description: |
7681
The Git revision of the ORT configuration repository to use.
82+
By default set to 'main'.
7783
ORT_DISABLE_ADVISOR:
7884
value: ""
79-
description: "If set to 'true', ORT's advisor will not run (no security vulnerability checks)."
85+
description: |
86+
If set to 'true', ORT's advisor will not run (no security vulnerability checks).
87+
By default set to 'false'.
8088
ORT_DISABLE_EVALUATOR:
8189
value: ""
82-
description: "If set to 'true', ORT's evaluator will not run (no policy checks)."
90+
description: |
91+
If set to 'true', ORT's evaluator will not run (no policy checks).
92+
By default set to 'true'.
8393
ORT_DISABLE_SCANNER:
8494
value: ""
85-
description: "If set to 'true', ORT's scanner will not run (no copyright holders and licenses scan)."
95+
description: |
96+
If set to 'true', ORT's scanner will not run (no copyright holders and licenses scan).
97+
By default set to 'false'.
8698
ORT_LOG_LEVEL:
8799
value: ""
88-
description: "Set value to 'debug' to see additional debug output to help tracking down errors. If empty 'performance' is used as default."
100+
description: |
101+
Set value to 'debug' to see additional debug output to help tracking down errors.
102+
By default set to 'performance'.
89103
ORT_REVISION:
90104
value: ""
91105
description: |

0 commit comments

Comments
 (0)