summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2018-02-21 15:58:41 +0000
committerRémy Coutable <remy@rymai.me>2018-02-21 15:58:41 +0000
commit5d0cd8b6e990f2e23a7a2ae486b3aa0d83043b89 (patch)
tree2b906a6bd4d026caef47ca7987f006fbac5a17ed
parentca297d7a6f098a9ab5e9ee4b9937c15b8c973e94 (diff)
parent73f999d436b438b61efed262fba70497c40808e9 (diff)
downloadgitlab-ce-5d0cd8b6e990f2e23a7a2ae486b3aa0d83043b89.tar.gz
Merge branch 'bug/misleading-ci-yaml-documentation' into 'master'
Fixes an invalid documentation for the .gitlab-ci.yml cache:key See merge request gitlab-org/gitlab-ce!17047
-rw-r--r--doc/ci/yaml/README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index 4a650303d45..80ab63468f2 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -276,7 +276,7 @@ To enable per-branch caching:
```yaml
cache:
- key: "$CI_COMMIT_REF_NAME"
+ key: "$CI_COMMIT_REF_SLUG"
untracked: true
```
@@ -284,7 +284,7 @@ To enable per-job and per-branch caching:
```yaml
cache:
- key: "$CI_JOB_NAME-$CI_COMMIT_REF_NAME"
+ key: "$CI_JOB_NAME-$CI_COMMIT_REF_SLUG"
untracked: true
```
@@ -292,7 +292,7 @@ To enable per-branch and per-stage caching:
```yaml
cache:
- key: "$CI_JOB_STAGE-$CI_COMMIT_REF_NAME"
+ key: "$CI_JOB_STAGE-$CI_COMMIT_REF_SLUG"
untracked: true
```
@@ -301,7 +301,7 @@ If you use **Windows Batch** to run your shell scripts you need to replace
```yaml
cache:
- key: "%CI_JOB_STAGE%-%CI_COMMIT_REF_NAME%"
+ key: "%CI_JOB_STAGE%-%CI_COMMIT_REF_SLUG%"
untracked: true
```
@@ -310,7 +310,7 @@ If you use **Windows PowerShell** to run your shell scripts you need to replace
```yaml
cache:
- key: "$env:CI_JOB_STAGE-$env:CI_COMMIT_REF_NAME"
+ key: "$env:CI_JOB_STAGE-$env:CI_COMMIT_REF_SLUG"
untracked: true
```