diff options
| author | Steve Azzopardi <sazzopardi@gitlab.com> | 2019-04-23 11:43:31 +0200 |
|---|---|---|
| committer | Steve Azzopardi <sazzopardi@gitlab.com> | 2019-04-23 11:46:56 +0200 |
| commit | 1429fdbb2f5d2479ea64d7461719bb3368f1bf85 (patch) | |
| tree | db3ac2efecb816e265bf737be862e3b09b5fc7d8 | |
| parent | d3902ca028c3ee5441e35d505d4bfd32c86e03f2 (diff) | |
| download | gitlab-ce-docs/60785-docs-feedback-masked-variables-is-not-clear-what-unescaped-characters-means.tar.gz | |
Clarify masked variables docsdocs/60785-docs-feedback-masked-variables-is-not-clear-what-unescaped-characters-means
- Add note that must contain only letters, numbers, underscore
- Add example of escape characters
- Add regex used for validation
closes https://gitlab.com/gitlab-org/gitlab-ce/issues/60785
| -rw-r--r-- | doc/ci/variables/README.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md index 830f015a108..29941839125 100644 --- a/doc/ci/variables/README.md +++ b/doc/ci/variables/README.md @@ -143,14 +143,16 @@ 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 in a single line. -- The value must not have escape characters. +- The value must contain only letters, number, underscore. +- The value must not have escape characters, such as `\"` - 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. +To validate the rules above we are using the following regex `/\A\w{8,}\z/`. 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 |