summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Lewis <mlewis@gitlab.com>2019-04-17 16:02:42 +0000
committerMike Lewis <mlewis@gitlab.com>2019-04-17 16:02:42 +0000
commitd7af5ab7d49a6190d4741aac4764bdc3c6973599 (patch)
tree680a253f7d465263ec543a453fb426cbb9edb859
parent6ef494369dc415c869ff31d717398d2a461552f6 (diff)
parent05e367900d43dd0c55ba411a235c6471644b3383 (diff)
downloadgitlab-ce-d7af5ab7d49a6190d4741aac4764bdc3c6973599.tar.gz
Merge branch 'masked-variables-docs-update-docs-only' into 'master'
Add Masked Variables to Variables documentation See merge request gitlab-org/gitlab-ce!27236
-rw-r--r--doc/ci/variables/README.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md
index 61d1a904f76..afd578e2621 100644
--- a/doc/ci/variables/README.md
+++ b/doc/ci/variables/README.md
@@ -136,12 +136,21 @@ The output will be:
![Output custom variable](img/custom_variable_output.png)
-CAUTION: **Important:**
-Be aware that variables are not masked, and their values can be shown
-in the job logs if explicitly asked to do so. If your project is public or
-internal, you can set the pipelines private from your [project's Pipelines
-settings](../../user/project/pipelines/settings.md#visibility-of-pipelines).
-Follow the discussion in issue [#13784][ce-13784] for masking the variables.
+### Masked Variables
+
+By default, variables will be created as masked variables.
+This means that the value of the variable will be hidden in job logs,
+though it must match certain requirements to do so:
+
+- The value must be a single line.
+- The value must not have escape characters.
+- The value must not use variables.
+- The value must not have any whitespace.
+- The value must be at least 8 characters long.
+
+If the value does not meet the requirements above, then the CI variable will fail to save.
+In order to save, either alter the value to meet the masking requirements
+or disable `Masked` for the variable.
### Syntax of environment variables in job scripts