Commit bc2214da authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'doc_codeblock_fix' into 'master'

Fix broken codeblocks in ci/yaml documentation



See merge request !2554
parents a4a46437 22544132
No related merge requests found
...@@ -159,50 +159,55 @@ The `key` directive allows you to define the affinity of caching ...@@ -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, between jobs, allowing to have a single cache for all jobs,
cache per-job, cache per-branch or any other way you deem proper. 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. This allows you to fine tune caching, allowing you to cache data between
The `cache:key` variable can use any of the [predefined variables](../variables/README.md): 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: To enable per-job caching:
```yaml ```yaml
cache: cache:
key: "$CI_BUILD_NAME" key: "$CI_BUILD_NAME"
untracked: true untracked: true
``` ```
To enable per-branch caching: To enable per-branch caching:
```yaml ```yaml
cache: cache:
key: "$CI_BUILD_REF_NAME" key: "$CI_BUILD_REF_NAME"
untracked: true untracked: true
``` ```
To enable per-job and per-branch caching: To enable per-job and per-branch caching:
```yaml ```yaml
cache: cache:
key: "$CI_BUILD_NAME/$CI_BUILD_REF_NAME" key: "$CI_BUILD_NAME/$CI_BUILD_REF_NAME"
untracked: true untracked: true
``` ```
To enable per-branch and per-stage caching: To enable per-branch and per-stage caching:
```yaml ```yaml
cache: cache:
key: "$CI_BUILD_STAGE/$CI_BUILD_REF_NAME" key: "$CI_BUILD_STAGE/$CI_BUILD_REF_NAME"
untracked: true 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 ```yaml
cache: cache:
key: "%CI_BUILD_STAGE%/%CI_BUILD_REF_NAME%" key: "%CI_BUILD_STAGE%/%CI_BUILD_REF_NAME%"
untracked: true untracked: true
``` ```
## Jobs ## Jobs
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment