diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-01-22 12:33:37 +0100 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-01-22 12:33:37 +0100 |
| commit | 2254413267f69ddf2a84a37ae4c90b5cc248ec94 (patch) | |
| tree | a6c393ca3b4c7146a0f9f582682eeee48dace935 | |
| parent | a4a46437657eba267186de71478a6e3a8644dee3 (diff) | |
| download | gitlab-ce-2254413267f69ddf2a84a37ae4c90b5cc248ec94.tar.gz | |
Fix broken codeblocks in ci/yaml documentation
[ci skip]
| -rw-r--r-- | doc/ci/yaml/README.md | 63 |
1 files changed, 34 insertions, 29 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 3b594df659d..c8d5ecb8eef 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -159,50 +159,55 @@ The `key` directive allows you to define the affinity of caching between jobs, allowing to have a single cache for all jobs, cache per-job, cache per-branch or any other way you deem proper. -This allows you to fine tune caching, allowing you to cache data between different jobs or even different branches. -The `cache:key` variable can use any of the [predefined variables](../variables/README.md): +This allows you to fine tune caching, allowing you to cache data between +different jobs or even different branches. -Example configurations: +The `cache:key` variable can use any of the [predefined variables](../variables/README.md). + +--- + +**Example configurations** To enable per-job caching: - ```yaml - cache: - key: "$CI_BUILD_NAME" - untracked: true - ``` +```yaml +cache: + key: "$CI_BUILD_NAME" + untracked: true +``` To enable per-branch caching: - ```yaml - cache: - key: "$CI_BUILD_REF_NAME" - untracked: true - ``` +```yaml +cache: + key: "$CI_BUILD_REF_NAME" + untracked: true +``` To enable per-job and per-branch caching: - ```yaml - cache: - key: "$CI_BUILD_NAME/$CI_BUILD_REF_NAME" - untracked: true - ``` +```yaml +cache: + key: "$CI_BUILD_NAME/$CI_BUILD_REF_NAME" + untracked: true +``` To enable per-branch and per-stage caching: - ```yaml - cache: - key: "$CI_BUILD_STAGE/$CI_BUILD_REF_NAME" - untracked: true - ``` +```yaml +cache: + key: "$CI_BUILD_STAGE/$CI_BUILD_REF_NAME" + untracked: true +``` -If you use **Windows Batch** to run your shell scripts you need to replace the `$` with `%`: +If you use **Windows Batch** to run your shell scripts you need to replace +`$` with `%`: - ```yaml - cache: - key: "%CI_BUILD_STAGE%/%CI_BUILD_REF_NAME%" - untracked: true - ``` +```yaml +cache: + key: "%CI_BUILD_STAGE%/%CI_BUILD_REF_NAME%" + untracked: true +``` ## Jobs |