Commit 3bbe60f8 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs/ci-yaml-cleanup' into 'master'

Cleanup and consolidate the CI yaml docs

Closes #42914 and #18945

See merge request gitlab-org/gitlab-ce!17595
parents 1f65191e 93e45424
...@@ -12,7 +12,7 @@ this order: ...@@ -12,7 +12,7 @@ this order:
1. [Trigger variables][triggers] or [scheduled pipeline variables](../../user/project/pipelines/schedules.md#making-use-of-scheduled-pipeline-variables) (take precedence over all) 1. [Trigger variables][triggers] or [scheduled pipeline variables](../../user/project/pipelines/schedules.md#making-use-of-scheduled-pipeline-variables) (take precedence over all)
1. Project-level [secret variables](#secret-variables) or [protected secret variables](#protected-secret-variables) 1. Project-level [secret variables](#secret-variables) or [protected secret variables](#protected-secret-variables)
1. Group-level [secret variables](#secret-variables) or [protected secret variables](#protected-secret-variables) 1. Group-level [secret variables](#secret-variables) or [protected secret variables](#protected-secret-variables)
1. YAML-defined [job-level variables](../yaml/README.md#job-variables) 1. YAML-defined [job-level variables](../yaml/README.md#variables)
1. YAML-defined [global variables](../yaml/README.md#variables) 1. YAML-defined [global variables](../yaml/README.md#variables)
1. [Deployment variables](#deployment-variables) 1. [Deployment variables](#deployment-variables)
1. [Predefined variables](#predefined-variables-environment-variables) (are the 1. [Predefined variables](#predefined-variables-environment-variables) (are the
......
...@@ -3,18 +3,19 @@ ...@@ -3,18 +3,19 @@
This document describes the usage of `.gitlab-ci.yml`, the file that is used by This document describes the usage of `.gitlab-ci.yml`, the file that is used by
GitLab Runner to manage your project's jobs. GitLab Runner to manage your project's jobs.
If you want a quick introduction to GitLab CI, follow our
[quick start guide](../quick_start/README.md).
## .gitlab-ci.yml
From version 7.12, GitLab CI uses a [YAML](https://en.wikipedia.org/wiki/YAML) From version 7.12, GitLab CI uses a [YAML](https://en.wikipedia.org/wiki/YAML)
file (`.gitlab-ci.yml`) for the project configuration. It is placed in the root file (`.gitlab-ci.yml`) for the project configuration. It is placed in the root
of your repository and contains definitions of how your project should be built. of your repository and contains definitions of how your project should be built.
If you want a quick introduction to GitLab CI, follow our
[quick start guide](../quick_start/README.md).
## Jobs
The YAML file defines a set of jobs with constraints stating when they should The YAML file defines a set of jobs with constraints stating when they should
be run. The jobs are defined as top-level elements with a name and always have be run. You can specify an unlimited number of jobs which are defined as
to contain at least the `script` clause: top-level elements with an arbitrary name and always have to contain at least
the `script` clause.
```yaml ```yaml
job1: job1:
...@@ -24,9 +25,8 @@ job2: ...@@ -24,9 +25,8 @@ job2:
script: "execute-script-for-job2" script: "execute-script-for-job2"
``` ```
The above example is the simplest possible CI configuration with two separate The above example is the simplest possible CI/CD configuration with two separate
jobs, where each of the jobs executes a different command. jobs, where each of the jobs executes a different command.
Of course a command can execute code directly (`./configure;make;make install`) Of course a command can execute code directly (`./configure;make;make install`)
or run a script (`test.sh`) in the repository. or run a script (`test.sh`) in the repository.
...@@ -34,78 +34,115 @@ Jobs are picked up by [Runners](../runners/README.md) and executed within the ...@@ -34,78 +34,115 @@ Jobs are picked up by [Runners](../runners/README.md) and executed within the
environment of the Runner. What is important, is that each job is run environment of the Runner. What is important, is that each job is run
independently from each other. independently from each other.
The YAML syntax allows for using more complex job specifications than in the Each job must have a unique name, but there are a few **reserved `keywords` that
above example: cannot be used as job names**:
```yaml - `image`
image: ruby:2.1 - `services`
services: - `stages`
- postgres - `types`
- `before_script`
- `after_script`
- `variables`
- `cache`
before_script: A job is defined by a list of parameters that define the job behavior.
- bundle install
after_script: | Keyword | Required | Description |
- rm secrets |---------------|----------|-------------|
| script | yes | Defines a shell script which is executed by Runner |
| image | no | Use docker image, covered in [Using Docker Images](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml) |
| services | no | Use docker services, covered in [Using Docker Images](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml) |
| stage | no | Defines a job stage (default: `test`) |
| type | no | Alias for `stage` |
| variables | no | Define job variables on a job level |
| only | no | Defines a list of git refs for which job is created |
| except | no | Defines a list of git refs for which job is not created |
| tags | no | Defines a list of tags which are used to select Runner |
| allow_failure | no | Allow job to fail. Failed job doesn't contribute to commit status |
| when | no | Define when to run job. Can be `on_success`, `on_failure`, `always` or `manual` |
| dependencies | no | Define other jobs that a job depends on so that you can pass artifacts between them|
| artifacts | no | Define list of [job artifacts](#artifacts) |
| cache | no | Define list of files that should be cached between subsequent runs |
| before_script | no | Override a set of commands that are executed before job |
| after_script | no | Override a set of commands that are executed after job |
| environment | no | Defines a name of environment to which deployment is done by this job |
| coverage | no | Define code coverage settings for a given job |
| retry | no | Define how many times a job can be auto-retried in case of a failure |
stages: ### `pages`
- build
- test
- deploy
job1: `pages` is a special job that is used to upload static content to GitLab that
stage: build can be used to serve your website. It has a special syntax, so the two
requirements below must be met:
1. Any static content must be placed under a `public/` directory
1. `artifacts` with a path to the `public/` directory must be defined
The example below simply moves all files from the root of the project to the
`public/` directory. The `.public` workaround is so `cp` doesn't also copy
`public/` to itself in an infinite loop:
```
pages:
stage: deploy
script: script:
- execute-script-for-job1 - mkdir .public
- cp -r * .public
- mv .public public
artifacts:
paths:
- public
only: only:
- master - master
tags:
- docker
``` ```
There are a few reserved `keywords` that **cannot** be used as job names: Read more on [GitLab Pages user documentation](../../user/project/pages/index.md).
| Keyword | Required | Description |
|---------------|----------|-------------|
| image | no | Use docker image, covered in [Use Docker](../docker/README.md) |
| services | no | Use docker services, covered in [Use Docker](../docker/README.md) |
| stages | no | Define build stages |
| types | no | Alias for `stages` (deprecated) |
| before_script | no | Define commands that run before each job's script |
| after_script | no | Define commands that run after each job's script |
| variables | no | Define build variables |
| cache | no | Define list of files that should be cached between subsequent runs |
### image and services ## `image` and `services`
This allows to specify a custom Docker image and a list of services that can be This allows to specify a custom Docker image and a list of services that can be
used for time of the job. The configuration of this feature is covered in used for time of the job. The configuration of this feature is covered in
[a separate document](../docker/README.md). [a separate document](../docker/README.md).
### before_script ## `before_script` and `after_script`
`before_script` is used to define the command that should be run before all
jobs, including deploy jobs, but after the restoration of artifacts. This can
be an array or a multi-line string.
### after_script
> Introduced in GitLab 8.7 and requires Gitlab Runner v1.2 > Introduced in GitLab 8.7 and requires Gitlab Runner v1.2
`before_script` is used to define the command that should be run before all
jobs, including deploy jobs, but after the restoration of [artifacts](#artifacts).
This can be an array or a multi-line string.
`after_script` is used to define the command that will be run after for all `after_script` is used to define the command that will be run after for all
jobs, including failed ones. This has to be an array or a multi-line string. jobs, including failed ones. This has to be an array or a multi-line string.
> **Note:**
The `before_script` and the main `script` are concatenated and run in a single context/container. The `before_script` and the main `script` are concatenated and run in a single context/container.
The `after_script` is run separately, so depending on the executor, changes done The `after_script` is run separately, so depending on the executor, changes done
outside of the working tree might not be visible, e.g. software installed in the outside of the working tree might not be visible, e.g. software installed in the
`before_script`. `before_script`.
### stages It's possible to overwrite the globally defined `before_script` and `after_script`
if you set it per-job:
`stages` is used to define stages that can be used by jobs. ```yaml
The specification of `stages` allows for having flexible multi stage pipelines. before_script:
- global before script
job:
before_script:
- execute this instead of global before script
script:
- my command
after_script:
- execute this after my script
```
## `stages`
`stages` is used to define stages that can be used by jobs and is defined
globally.
The specification of `stages` allows for having flexible multi stage pipelines.
The ordering of elements in `stages` defines the ordering of jobs' execution: The ordering of elements in `stages` defines the ordering of jobs' execution:
1. Jobs of the same stage are run in parallel. 1. Jobs of the same stage are run in parallel.
...@@ -125,289 +162,54 @@ stages: ...@@ -125,289 +162,54 @@ stages:
1. If all jobs of `build` succeed, the `test` jobs are executed in parallel. 1. If all jobs of `build` succeed, the `test` jobs are executed in parallel.
1. If all jobs of `test` succeed, the `deploy` jobs are executed in parallel. 1. If all jobs of `test` succeed, the `deploy` jobs are executed in parallel.
1. If all jobs of `deploy` succeed, the commit is marked as `passed`. 1. If all jobs of `deploy` succeed, the commit is marked as `passed`.
1. If any of the previous jobs fails, the commit is marked as `failed` and no 1. If any of the previous jobs fails, the commit is marked as `failed` and no
jobs of further stage are executed. jobs of further stage are executed.
There are also two edge cases worth mentioning:
1. If no `stages` are defined in `.gitlab-ci.yml`, then the `build`,
`test` and `deploy` are allowed to be used as job's stage by default.
2. If a job doesn't specify a `stage`, the job is assigned the `test` stage.
### types
> Deprecated, and could be removed in one of the future releases. Use [stages](#stages) instead.
Alias for [stages](#stages).
### variables
> Introduced in GitLab Runner v0.5.0.
GitLab CI allows you to add variables to `.gitlab-ci.yml` that are set in the
job environment. The variables are stored in the Git repository and are meant
to store non-sensitive project configuration, for example:
```yaml
variables:
DATABASE_URL: "postgres://postgres@postgres/my_database"
```
>**Note:**
Integers (as well as strings) are legal both for variable's name and value.
Floats are not legal and cannot be used.
These variables can be later used in all executed commands and scripts.
The YAML-defined variables are also set to all created service containers,
thus allowing to fine tune them. Variables can be also defined on a
[job level](#job-variables).
Except for the user defined variables, there are also the ones set up by the
Runner itself. One example would be `CI_COMMIT_REF_NAME` which has the value of
the branch or tag name for which project is built. Apart from the variables
you can set in `.gitlab-ci.yml`, there are also the so called secret variables
which can be set in GitLab's UI.
[Learn more about variables.][variables]
### cache
>
**Notes:**
- Introduced in GitLab Runner v0.7.0.
- Prior to GitLab 9.2, caches were restored after artifacts.
- From GitLab 9.2, caches are restored before artifacts.
`cache` is used to specify a list of files and directories which should be
cached between jobs. You can only use paths that are within the project
workspace.
**By default caching is enabled and shared between pipelines and jobs,
starting from GitLab 9.0**
If `cache` is defined outside the scope of jobs, it means it is set
globally and all jobs will use that definition.
Cache all files in `binaries` and `.config`:
```yaml
rspec:
script: test
cache:
paths:
- binaries/
- .config
```
Cache all Git untracked files:
```yaml
rspec:
script: test
cache:
untracked: true
```
Cache all Git untracked files and files in `binaries`:
```yaml
rspec:
script: test
cache:
untracked: true
paths:
- binaries/
```
Locally defined cache overrides globally defined options. The following `rspec`
job will cache only `binaries/`:
```yaml
cache:
paths:
- my/files
rspec:
script: test
cache:
key: rspec
paths:
- binaries/
```
Note that since cache is shared between jobs, if you're using different
paths for different jobs, you should also set a different **cache:key**
otherwise cache content can be overwritten.
The cache is provided on a best-effort basis, so don't expect that the cache
will be always present. For implementation details, please check GitLab Runner.
#### cache:key
> Introduced in GitLab Runner v1.0.0.
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).
The default key is **default** across the project, therefore everything is
shared between each pipelines and jobs by default, starting from GitLab 9.0.
>**Note:** The `cache:key` variable cannot contain the `/` character, or the equivalent URI encoded `%2F`; a value made only of dots (`.`, `%2E`) is also forbidden.
---
**Example configurations**
To enable per-job caching:
```yaml
cache:
key: "$CI_JOB_NAME"
untracked: true
```
To enable per-branch caching:
```yaml
cache:
key: "$CI_COMMIT_REF_SLUG"
untracked: true
```
To enable per-job and per-branch caching:
```yaml
cache:
key: "$CI_JOB_NAME-$CI_COMMIT_REF_SLUG"
untracked: true
```
To enable per-branch and per-stage caching:
```yaml
cache:
key: "$CI_JOB_STAGE-$CI_COMMIT_REF_SLUG"
untracked: true
```
If you use **Windows Batch** to run your shell scripts you need to replace
`$` with `%`:
```yaml
cache:
key: "%CI_JOB_STAGE%-%CI_COMMIT_REF_SLUG%"
untracked: true
```
If you use **Windows PowerShell** to run your shell scripts you need to replace
`$` with `$env:`:
```yaml
cache:
key: "$env:CI_JOB_STAGE-$env:CI_COMMIT_REF_SLUG"
untracked: true
```
### cache:policy
> Introduced in GitLab 9.4.
The default behaviour of a caching job is to download the files at the start of
execution, and to re-upload them at the end. This allows any changes made by the
job to be persisted for future runs, and is known as the `pull-push` cache
policy.
If you know the job doesn't alter the cached files, you can skip the upload step
by setting `policy: pull` in the job specification. Typically, this would be
twinned with an ordinary cache job at an earlier stage to ensure the cache
is updated from time to time:
```yaml
stages:
- setup
- test
prepare:
stage: setup
cache:
key: gems
paths:
- vendor/bundle
script:
- bundle install --deployment
rspec:
stage: test
cache:
key: gems
paths:
- vendor/bundle
policy: pull
script:
- bundle exec rspec ...
```
This helps to speed up job execution and reduce load on the cache server, There are also two edge cases worth mentioning:
especially when you have a large number of cache-using jobs executing in
parallel.
Additionally, if you have a job that unconditionally recreates the cache without 1. If no `stages` are defined in `.gitlab-ci.yml`, then the `build`,
reference to its previous contents, you can use `policy: push` in that job to `test` and `deploy` are allowed to be used as job's stage by default.
skip the download step. 2. If a job doesn't specify a `stage`, the job is assigned the `test` stage.
## Jobs ## `stage`
`.gitlab-ci.yml` allows you to specify an unlimited number of jobs. Each job `stage` is defined per-job and relies on [`stages`](#stages) which is defined
must have a unique name, which is not one of the keywords mentioned above. globally. It allows to group jobs into different stages, and jobs of the same
A job is defined by a list of parameters that define the job behavior. `stage` are executed in `parallel`. For example:
```yaml ```yaml
job_name: stages:
script: - build
- rake spec - test
- coverage - deploy
job 1:
stage: build
script: make build dependencies
job 2:
stage: build
script: make build artifacts
job 3:
stage: test stage: test
only: script: make test
- master
except: job 4:
- develop stage: deploy
tags: script: make deploy
- ruby
- postgres
allow_failure: true
``` ```
| Keyword | Required | Description | ## `types`
|---------------|----------|-------------|
| script | yes | Defines a shell script which is executed by Runner |
| image | no | Use docker image, covered in [Using Docker Images](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml) |
| services | no | Use docker services, covered in [Using Docker Images](../docker/using_docker_images.md#define-image-and-services-from-gitlab-ciyml) |
| stage | no | Defines a job stage (default: `test`) |
| type | no | Alias for `stage` |
| variables | no | Define job variables on a job level |
| only | no | Defines a list of git refs for which job is created |
| except | no | Defines a list of git refs for which job is not created |
| tags | no | Defines a list of tags which are used to select Runner |
| allow_failure | no | Allow job to fail. Failed job doesn't contribute to commit status |
| when | no | Define when to run job. Can be `on_success`, `on_failure`, `always` or `manual` |
| dependencies | no | Define other jobs that a job depends on so that you can pass artifacts between them|
| artifacts | no | Define list of [job artifacts](../../user/project/pipelines/job_artifacts.md) |
| cache | no | Define list of files that should be cached between subsequent runs |
| before_script | no | Override a set of commands that are executed before job |
| after_script | no | Override a set of commands that are executed after job |
| environment | no | Defines a name of environment to which deployment is done by this job |
| coverage | no | Define code coverage settings for a given job |
| retry | no | Define how many times a job can be auto-retried in case of a failure |
### script CAUTION: **Deprecated:**
`types` is deprecated, and could be removed in one of the future releases.
Use [stages](#stages) instead.
`script` is a shell script which is executed by the Runner. For example: ## `script`
`script` is the only required keyword that a job needs. It's a shell script
which is executed by the Runner. For example:
```yaml ```yaml
job: job:
...@@ -429,13 +231,7 @@ that the YAML parser knows to interpret the whole thing as a string rather than ...@@ -429,13 +231,7 @@ that the YAML parser knows to interpret the whole thing as a string rather than
a "key: value" pair. Be careful when using special characters: a "key: value" pair. Be careful when using special characters:
`:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `` ` ``. `:`, `{`, `}`, `[`, `]`, `,`, `&`, `*`, `#`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`, `` ` ``.
### stage ## `only` and `except` (simplified)
`stage` allows to group jobs into different stages. Jobs of the same `stage`
are executed in `parallel`. For more info about the use of `stage` please check
[stages](#stages).
### only and except (simplified)
`only` and `except` are two parameters that set a job policy to limit when `only` and `except` are two parameters that set a job policy to limit when
jobs are created: jobs are created:
...@@ -505,12 +301,13 @@ job: ...@@ -505,12 +301,13 @@ job:
The above example will run `job` for all branches on `gitlab-org/gitlab-ce`, The above example will run `job` for all branches on `gitlab-org/gitlab-ce`,
except master. except master.
### only and except (complex) ## `only` and `except` (complex)
> Introduced in GitLab 10.0 > Introduced in GitLab 10.0
> This an _alpha_ feature, and it it subject to change at any time without CAUTION: **Warning:**
prior notice! This an _alpha_ feature, and it it subject to change at any time without
prior notice!
Since GitLab 10.0 it is possible to define a more elaborate only/except job Since GitLab 10.0 it is possible to define a more elaborate only/except job
policy configuration. policy configuration.
...@@ -535,24 +332,7 @@ job: ...@@ -535,24 +332,7 @@ job:
kubernetes: active kubernetes: active
``` ```
### Job variables ## `tags`
It is possible to define job variables using a `variables` keyword on a job
level. It works basically the same way as its [global-level equivalent](#variables),
but allows you to define job-specific variables.
When the `variables` keyword is used on a job level, it overrides the global YAML
job variables and predefined ones. To turn off global defined variables
in your job, define an empty hash:
```yaml
job_name:
variables: {}
```
Job variables priority is defined in the [variables documentation][variables].
### tags
`tags` is used to select specific Runners from the list of all Runners that are `tags` is used to select specific Runners from the list of all Runners that are
allowed to run this project. allowed to run this project.
...@@ -573,7 +353,7 @@ job: ...@@ -573,7 +353,7 @@ job:
The specification above, will make sure that `job` is built by a Runner that The specification above, will make sure that `job` is built by a Runner that
has both `ruby` AND `postgres` tags defined. has both `ruby` AND `postgres` tags defined.
### allow_failure ## `allow_failure`
`allow_failure` is used when you want to allow a job to fail without impacting `allow_failure` is used when you want to allow a job to fail without impacting
the rest of the CI suite. Failed jobs don't contribute to the commit status. the rest of the CI suite. Failed jobs don't contribute to the commit status.
...@@ -606,7 +386,7 @@ job3: ...@@ -606,7 +386,7 @@ job3:
- deploy_to_staging - deploy_to_staging
``` ```
### when ## `when`
`when` is used to implement jobs that are run in case of failure or despite the `when` is used to implement jobs that are run in case of failure or despite the
failure. failure.
...@@ -619,7 +399,7 @@ failure. ...@@ -619,7 +399,7 @@ failure.
fails. fails.
1. `always` - execute job regardless of the status of jobs from prior stages. 1. `always` - execute job regardless of the status of jobs from prior stages.
1. `manual` - execute job manually (added in GitLab 8.10). Read about 1. `manual` - execute job manually (added in GitLab 8.10). Read about
[manual actions](#manual-actions) below. [manual actions](#when-manual) below.
For example: For example:
...@@ -667,42 +447,41 @@ The above script will: ...@@ -667,42 +447,41 @@ The above script will:
success or failure. success or failure.
3. Allow you to manually execute `deploy_job` from GitLab's UI. 3. Allow you to manually execute `deploy_job` from GitLab's UI.
#### Manual actions ### `when:manual`
> Introduced in GitLab 8.10.
> Blocking manual actions were introduced in GitLab 9.0
> Protected actions were introduced in GitLab 9.2
Manual actions are a special type of job that are not executed automatically;
they need to be explicitly started by a user. Manual actions can be started
from pipeline, build, environment, and deployment views.
An example usage of manual actions is deployment to production. > **Notes:**
- Introduced in GitLab 8.10.
- Blocking manual actions were introduced in GitLab 9.0.
- Protected actions were introduced in GitLab 9.2.
Read more at the [environments documentation][env-manual]. Manual actions are a special type of job that are not executed automatically,
they need to be explicitly started by a user. An example usage of manual actions
would be a deployment to a production environment. Manual actions can be started
from the pipeline, job, environment, and deployment views. Read more at the
[environments documentation][env-manual].
Manual actions can be either optional or blocking. Blocking manual action will Manual actions can be either optional or blocking. Blocking manual actions will
block execution of the pipeline at stage this action is defined in. It is block the execution of the pipeline at the stage this action is defined in. It's
possible to resume execution of the pipeline when someone executes a blocking possible to resume execution of the pipeline when someone executes a blocking
manual actions by clicking a _play_ button. manual action by clicking a _play_ button.
When pipeline is blocked it will not be merged if Merge When Pipeline Succeeds When a pipeline is blocked, it will not be merged if Merge When Pipeline Succeeds
is set. Blocked pipelines also do have a special status, called _manual_. is set. Blocked pipelines also do have a special status, called _manual_.
Manual actions are non-blocking by default. If you want to make manual action Manual actions are non-blocking by default. If you want to make manual action
blocking, it is necessary to add `allow_failure: false` to the job's definition blocking, it is necessary to add `allow_failure: false` to the job's definition
in `.gitlab-ci.yml`. in `.gitlab-ci.yml`.
Optional manual actions have `allow_failure: true` set by default. Optional manual actions have `allow_failure: true` set by default and their
Statuses do not contribute to the overall pipeline status. So, if a manual
**Statuses of optional actions do not contribute to overall pipeline status.** action fails, the pipeline will eventually succeed.
**Manual actions are considered to be write actions, so permissions for Manual actions are considered to be write actions, so permissions for
protected branches are used when user wants to trigger an action. In other [protected branches](../../user/project/protected_branches.md) are used when
words, in order to trigger a manual action assigned to a branch that the user wants to trigger an action. In other words, in order to trigger a manual
pipeline is running for, user needs to have ability to merge to this branch.** action assigned to a branch that the pipeline is running for, user needs to
have ability to merge to this branch.
### environment ## `environment`
> >
**Notes:** **Notes:**
...@@ -727,7 +506,7 @@ deploy to production: ...@@ -727,7 +506,7 @@ deploy to production:
In the above example, the `deploy to production` job will be marked as doing a In the above example, the `deploy to production` job will be marked as doing a
deployment to the `production` environment. deployment to the `production` environment.
#### environment:name ### `environment:name`
> >
**Notes:** **Notes:**
...@@ -766,7 +545,7 @@ deploy to production: ...@@ -766,7 +545,7 @@ deploy to production:
name: production name: production
``` ```
#### environment:url ### `environment:url`
> >
**Notes:** **Notes:**
...@@ -793,7 +572,7 @@ deploy to production: ...@@ -793,7 +572,7 @@ deploy to production:
url: https://prod.example.com url: https://prod.example.com
``` ```
#### environment:on_stop ### `environment:on_stop`
> >
**Notes:** **Notes:**
...@@ -808,90 +587,281 @@ the environment. ...@@ -808,90 +587,281 @@ the environment.
Read the `environment:action` section for an example. Read the `environment:action` section for an example.
#### environment:action ### `environment:action`
> [Introduced][ce-6669] in GitLab 8.13. > [Introduced][ce-6669] in GitLab 8.13.
The `action` keyword is to be used in conjunction with `on_stop` and is defined The `action` keyword is to be used in conjunction with `on_stop` and is defined
in the job that is called to close the environment. in the job that is called to close the environment.
Take for instance: Take for instance:
```yaml
review_app:
stage: deploy
script: make deploy-app
environment:
name: review
on_stop: stop_review_app
stop_review_app:
stage: deploy
script: make delete-app
when: manual
environment:
name: review
action: stop
```
In the above example we set up the `review_app` job to deploy to the `review`
environment, and we also defined a new `stop_review_app` job under `on_stop`.
Once the `review_app` job is successfully finished, it will trigger the
`stop_review_app` job based on what is defined under `when`. In this case we
set it up to `manual` so it will need a [manual action](#manual-actions) via
GitLab's web interface in order to run.
The `stop_review_app` job is **required** to have the following keywords defined:
- `when` - [reference](#when)
- `environment:name`
- `environment:action`
- `stage` should be the same as the `review_app` in order for the environment
to stop automatically when the branch is deleted
### Dynamic environments
>
**Notes:**
- [Introduced][ce-6323] in GitLab 8.12 and GitLab Runner 1.6.
- The `$CI_ENVIRONMENT_SLUG` was [introduced][ce-7983] in GitLab 8.15.
- The `name` and `url` parameters can use any of the defined CI variables,
including predefined, secure variables and `.gitlab-ci.yml` [`variables`](#variables).
You however cannot use variables defined under `script`.
For example:
```yaml
deploy as review app:
stage: deploy
script: make deploy
environment:
name: review/$CI_COMMIT_REF_NAME
url: https://$CI_ENVIRONMENT_SLUG.example.com/
```
The `deploy as review app` job will be marked as deployment to dynamically
create the `review/$CI_COMMIT_REF_NAME` environment, where `$CI_COMMIT_REF_NAME`
is an [environment variable][variables] set by the Runner. The
`$CI_ENVIRONMENT_SLUG` variable is based on the environment name, but suitable
for inclusion in URLs. In this case, if the `deploy as review app` job was run
in a branch named `pow`, this environment would be accessible with an URL like
`https://review-pow.example.com/`.
This of course implies that the underlying server which hosts the application
is properly configured.
The common use case is to create dynamic environments for branches and use them
as Review Apps. You can see a simple example using Review Apps at
<https://gitlab.com/gitlab-examples/review-apps-nginx/>.
## `cache`
>
**Notes:**
- Introduced in GitLab Runner v0.7.0.
- `cache` can be set globally and per-job.
- From GitLab 9.0, caching is enabled and shared between pipelines and jobs
by default.
- From GitLab 9.2, caches are restored before [artifacts](#artifacts).
`cache` is used to specify a list of files and directories which should be
cached between jobs. You can only use paths that are within the project
workspace.
If `cache` is defined outside the scope of jobs, it means it is set
globally and all jobs will use that definition.
Cache all files in `binaries` and `.config`:
```yaml
rspec:
script: test
cache:
paths:
- binaries/
- .config
```
Cache all Git untracked files:
```yaml
rspec:
script: test
cache:
untracked: true
```
Cache all Git untracked files and files in `binaries`:
```yaml
rspec:
script: test
cache:
untracked: true
paths:
- binaries/
```
Locally defined cache overrides globally defined options. The following `rspec`
job will cache only `binaries/`:
```yaml
cache:
paths:
- my/files
rspec:
script: test
cache:
key: rspec
paths:
- binaries/
```
Note that since cache is shared between jobs, if you're using different
paths for different jobs, you should also set a different **cache:key**
otherwise cache content can be overwritten.
NOTE: **Note:**
The cache is provided on a best-effort basis, so don't expect that the cache
will be always present.
### `cache:key`
> Introduced in GitLab Runner v1.0.0.
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 that fits your needs.
This way, you can 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), and the default key, if not set,
is set as `$CI_JOB_NAME-$CI_COMMIT_REF_NAME` which translates as "per-job and
per-branch". It is the default across the project, therefore everything is
shared between pipelines and jobs running on the same branch by default.
NOTE: **Note:**
The `cache:key` variable cannot contain the `/` character, or the equivalent
URI-encoded `%2F`; a value made only of dots (`.`, `%2E`) is also forbidden.
**Example configurations**
To enable per-job caching:
```yaml
cache:
key: "$CI_JOB_NAME"
untracked: true
```
To enable per-branch caching:
```yaml
cache:
key: "$CI_COMMIT_REF_SLUG"
untracked: true
```
To enable per-job and per-branch caching:
```yaml
cache:
key: "$CI_JOB_NAME-$CI_COMMIT_REF_SLUG"
untracked: true
```
To enable per-branch and per-stage caching:
```yaml
cache:
key: "$CI_JOB_STAGE-$CI_COMMIT_REF_SLUG"
untracked: true
```
If you use **Windows Batch** to run your shell scripts you need to replace
`$` with `%`:
```yaml
cache:
key: "%CI_JOB_STAGE%-%CI_COMMIT_REF_SLUG%"
untracked: true
```
If you use **Windows PowerShell** to run your shell scripts you need to replace
`$` with `$env:`:
```yaml ```yaml
review_app: cache:
stage: deploy key: "$env:CI_JOB_STAGE-$env:CI_COMMIT_REF_SLUG"
script: make deploy-app untracked: true
environment:
name: review
on_stop: stop_review_app
stop_review_app:
stage: deploy
script: make delete-app
when: manual
environment:
name: review
action: stop
``` ```
In the above example we set up the `review_app` job to deploy to the `review` ### `cache:policy`
environment, and we also defined a new `stop_review_app` job under `on_stop`.
Once the `review_app` job is successfully finished, it will trigger the
`stop_review_app` job based on what is defined under `when`. In this case we
set it up to `manual` so it will need a [manual action](#manual-actions) via
GitLab's web interface in order to run.
The `stop_review_app` job is **required** to have the following keywords defined: > Introduced in GitLab 9.4.
- `when` - [reference](#when) The default behaviour of a caching job is to download the files at the start of
- `environment:name` execution, and to re-upload them at the end. This allows any changes made by the
- `environment:action` job to be persisted for future runs, and is known as the `pull-push` cache
- `stage` should be the same as the `review_app` in order for the environment policy.
to stop automatically when the branch is deleted
#### dynamic environments If you know the job doesn't alter the cached files, you can skip the upload step
by setting `policy: pull` in the job specification. Typically, this would be
twinned with an ordinary cache job at an earlier stage to ensure the cache
is updated from time to time:
> ```yaml
**Notes:** stages:
- [Introduced][ce-6323] in GitLab 8.12 and GitLab Runner 1.6. - setup
- The `$CI_ENVIRONMENT_SLUG` was [introduced][ce-7983] in GitLab 8.15. - test
- The `name` and `url` parameters can use any of the defined CI variables,
including predefined, secure variables and `.gitlab-ci.yml` [`variables`](#variables).
You however cannot use variables defined under `script`.
For example: prepare:
stage: setup
cache:
key: gems
paths:
- vendor/bundle
script:
- bundle install --deployment
```yaml rspec:
deploy as review app: stage: test
stage: deploy cache:
script: make deploy key: gems
environment: paths:
name: review/$CI_COMMIT_REF_NAME - vendor/bundle
url: https://$CI_ENVIRONMENT_SLUG.example.com/ policy: pull
script:
- bundle exec rspec ...
``` ```
The `deploy as review app` job will be marked as deployment to dynamically This helps to speed up job execution and reduce load on the cache server,
create the `review/$CI_COMMIT_REF_NAME` environment, where `$CI_COMMIT_REF_NAME` especially when you have a large number of cache-using jobs executing in
is an [environment variable][variables] set by the Runner. The parallel.
`$CI_ENVIRONMENT_SLUG` variable is based on the environment name, but suitable
for inclusion in URLs. In this case, if the `deploy as review app` job was run
in a branch named `pow`, this environment would be accessible with an URL like
`https://review-pow.example.com/`.
This of course implies that the underlying server which hosts the application
is properly configured.
The common use case is to create dynamic environments for branches and use them Additionally, if you have a job that unconditionally recreates the cache without
as Review Apps. You can see a simple example using Review Apps at reference to its previous contents, you can use `policy: push` in that job to
<https://gitlab.com/gitlab-examples/review-apps-nginx/>. skip the download step.
### artifacts ## `artifacts`
> >
**Notes:** **Notes:**
- Introduced in GitLab Runner v0.7.0 for non-Windows platforms. - Introduced in GitLab Runner v0.7.0 for non-Windows platforms.
- Windows support was added in GitLab Runner v.1.0.0. - Windows support was added in GitLab Runner v.1.0.0.
- Prior to GitLab 9.2, caches were restored after artifacts.
- From GitLab 9.2, caches are restored before artifacts. - From GitLab 9.2, caches are restored before artifacts.
- Currently not all executors are supported. - Currently not all executors are supported.
- Job artifacts are only collected for successful jobs by default. - Job artifacts are only collected for successful jobs by default.
...@@ -960,7 +930,9 @@ release-job: ...@@ -960,7 +930,9 @@ release-job:
The artifacts will be sent to GitLab after the job finishes successfully and will The artifacts will be sent to GitLab after the job finishes successfully and will
be available for download in the GitLab UI. be available for download in the GitLab UI.
#### artifacts:name [Read more about artifacts.](../../user/project/pipelines/job_artifacts.md)
### `artifacts:name`
> Introduced in GitLab 8.6 and GitLab Runner v1.1.0. > Introduced in GitLab 8.6 and GitLab Runner v1.1.0.
...@@ -970,10 +942,6 @@ useful when you'd like to download the archive from GitLab. The `artifacts:name` ...@@ -970,10 +942,6 @@ useful when you'd like to download the archive from GitLab. The `artifacts:name`
variable can make use of any of the [predefined variables](../variables/README.md). variable can make use of any of the [predefined variables](../variables/README.md).
The default name is `artifacts`, which becomes `artifacts.zip` when downloaded. The default name is `artifacts`, which becomes `artifacts.zip` when downloaded.
---
**Example configurations**
To create an archive with a name of the current job: To create an archive with a name of the current job:
```yaml ```yaml
...@@ -1033,7 +1001,7 @@ job: ...@@ -1033,7 +1001,7 @@ job:
untracked: true untracked: true
``` ```
#### artifacts:when ### `artifacts:when`
> Introduced in GitLab 8.9 and GitLab Runner v1.3.0. > Introduced in GitLab 8.9 and GitLab Runner v1.3.0.
...@@ -1046,11 +1014,7 @@ failure. ...@@ -1046,11 +1014,7 @@ failure.
1. `on_failure` - upload artifacts only when the job fails. 1. `on_failure` - upload artifacts only when the job fails.
1. `always` - upload artifacts regardless of the job status. 1. `always` - upload artifacts regardless of the job status.
--- To upload artifacts only when job fails:
**Example configurations**
To upload artifacts only when job fails.
```yaml ```yaml
job: job:
...@@ -1058,22 +1022,23 @@ job: ...@@ -1058,22 +1022,23 @@ job:
when: on_failure when: on_failure
``` ```
#### artifacts:expire_in ### `artifacts:expire_in`
> Introduced in GitLab 8.9 and GitLab Runner v1.3.0. > Introduced in GitLab 8.9 and GitLab Runner v1.3.0.
`artifacts:expire_in` is used to delete uploaded artifacts after the specified `expire_in` allows you to specify how long artifacts should live before they
time. By default, artifacts are stored on GitLab forever. `expire_in` allows you expire and therefore deleted, counting from the time they are uploaded and
to specify how long artifacts should live before they expire, counting from the stored on GitLab. If the expiry time is not defined, it defaults to the
time they are uploaded and stored on GitLab. [instance wide setting](../../user/admin_area/settings/continuous_integration.md#default-artifacts-expiration)
(30 days by default, forever on GitLab.com).
You can use the **Keep** button on the job page to override expiration and You can use the **Keep** button on the job page to override expiration and
keep artifacts forever. keep artifacts forever.
After expiry, artifacts are actually deleted hourly by default (via a cron job), After their expiry, artifacts are deleted hourly by default (via a cron job),
but they are not accessible after expiry. and are not accessible anymore.
The value of `expire_in` is an elapsed time. Examples of parseable values: The value of `expire_in` is an elapsed time. Examples of parsable values:
- '3 mins 4 sec' - '3 mins 4 sec'
- '2 hrs 20 min' - '2 hrs 20 min'
...@@ -1082,10 +1047,6 @@ The value of `expire_in` is an elapsed time. Examples of parseable values: ...@@ -1082,10 +1047,6 @@ The value of `expire_in` is an elapsed time. Examples of parseable values:
- '47 yrs 6 mos and 4d' - '47 yrs 6 mos and 4d'
- '3 weeks and 2 days' - '3 weeks and 2 days'
---
**Example configurations**
To expire artifacts 1 week after being uploaded: To expire artifacts 1 week after being uploaded:
```yaml ```yaml
...@@ -1094,7 +1055,7 @@ job: ...@@ -1094,7 +1055,7 @@ job:
expire_in: 1 week expire_in: 1 week
``` ```
### dependencies ## `dependencies`
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1. > Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
...@@ -1153,7 +1114,7 @@ deploy: ...@@ -1153,7 +1114,7 @@ deploy:
script: make deploy script: make deploy
``` ```
#### When a dependent job will fail ### When a dependent job will fail
> Introduced in GitLab 10.3. > Introduced in GitLab 10.3.
...@@ -1167,27 +1128,9 @@ You can ask your administrator to ...@@ -1167,27 +1128,9 @@ You can ask your administrator to
[flip this switch](../../administration/job_artifacts.md#validation-for-dependencies) [flip this switch](../../administration/job_artifacts.md#validation-for-dependencies)
and bring back the old behavior. and bring back the old behavior.
### before_script and after_script ## `coverage`
It's possible to overwrite the globally defined `before_script` and `after_script`: > [Introduced][ce-7447] in GitLab 8.17.
```yaml
before_script:
- global before script
job:
before_script:
- execute this instead of global before script
script:
- my command
after_script:
- execute this after my script
```
### coverage
**Notes:**
- [Introduced][ce-7447] in GitLab 8.17.
`coverage` allows you to configure how code coverage will be extracted from the `coverage` allows you to configure how code coverage will be extracted from the
job output. job output.
...@@ -1205,10 +1148,9 @@ job1: ...@@ -1205,10 +1148,9 @@ job1:
coverage: '/Code coverage: \d+\.\d+/' coverage: '/Code coverage: \d+\.\d+/'
``` ```
### retry ## `retry`
**Notes:** > [Introduced][ce-3442] in GitLab 9.5.
- [Introduced][ce-3442] in GitLab 9.5.
`retry` allows you to configure how many times a job is going to be retried in `retry` allows you to configure how many times a job is going to be retried in
case of a failure. case of a failure.
...@@ -1228,16 +1170,57 @@ test: ...@@ -1228,16 +1170,57 @@ test:
retry: 2 retry: 2
``` ```
## Git Strategy ## `variables`
> Introduced in GitLab Runner v0.5.0.
NOTE: **Note:**
Integers (as well as strings) are legal both for variable's name and value.
Floats are not legal and cannot be used.
GitLab CI/CD allows you to define variables inside `.gitlab-ci.yml` that are
then passed in the job environment. They can be set globally and per-job.
When the `variables` keyword is used on a job level, it overrides the global
YAML variables and predefined ones.
They are stored in the Git repository and are meant to store non-sensitive
project configuration, for example:
```yaml
variables:
DATABASE_URL: "postgres://postgres@postgres/my_database"
```
These variables can be later used in all executed commands and scripts.
The YAML-defined variables are also set to all created service containers,
thus allowing to fine tune them.
To turn off global defined variables in a specific job, define an empty hash:
```yaml
job_name:
variables: {}
```
Except for the user defined variables, there are also the ones [set up by the
Runner itself](../variables/README.md#predefined-variables-environment-variables).
One example would be `CI_COMMIT_REF_NAME` which has the value of
the branch or tag name for which project is built. Apart from the variables
you can set in `.gitlab-ci.yml`, there are also the so called
[secret variables](../variables/README.md#secret-variables)
which can be set in GitLab's UI.
[Learn more about variables and their priority.][variables]
### Git strategy
> Introduced in GitLab 8.9 as an experimental feature. May change or be removed > Introduced in GitLab 8.9 as an experimental feature. May change or be removed
completely in future releases. `GIT_STRATEGY=none` requires GitLab Runner completely in future releases. `GIT_STRATEGY=none` requires GitLab Runner
v1.7+. v1.7+.
You can set the `GIT_STRATEGY` used for getting recent application code, either You can set the `GIT_STRATEGY` used for getting recent application code, either
in the global [`variables`](#variables) section or the [`variables`](#job-variables) globally or per-job in the [`variables`](#variables) section. If left
section for individual jobs. If left unspecified, the default from project unspecified, the default from project settings will be used.
settings will be used.
There are three possible values: `clone`, `fetch`, and `none`. There are three possible values: `clone`, `fetch`, and `none`.
...@@ -1269,44 +1252,13 @@ variables: ...@@ -1269,44 +1252,13 @@ variables:
GIT_STRATEGY: none GIT_STRATEGY: none
``` ```
## Git Checkout ### Git submodule strategy
> Introduced in GitLab Runner 9.3
The `GIT_CHECKOUT` variable can be used when the `GIT_STRATEGY` is set to either
`clone` or `fetch` to specify whether a `git checkout` should be run. If not
specified, it defaults to true. Like `GIT_STRATEGY`, it can be set in either the
global [`variables`](#variables) section or the [`variables`](#job-variables)
section for individual jobs.
If set to `false`, the Runner will:
- when doing `fetch` - update the repository and leave working copy on
the current revision,
- when doing `clone` - clone the repository and leave working copy on the
default branch.
Having this setting set to `true` will mean that for both `clone` and `fetch`
strategies the Runner will checkout the working copy to a revision related
to the CI pipeline:
```yaml
variables:
GIT_STRATEGY: clone
GIT_CHECKOUT: "false"
script:
- git checkout master
- git merge $CI_BUILD_REF_NAME
```
## Git Submodule Strategy
> Requires GitLab Runner v1.10+. > Requires GitLab Runner v1.10+.
The `GIT_SUBMODULE_STRATEGY` variable is used to control if / how Git The `GIT_SUBMODULE_STRATEGY` variable is used to control if / how Git
submodules are included when fetching the code before a build. Like submodules are included when fetching the code before a build. You can set them
`GIT_STRATEGY`, it can be set in either the global [`variables`](#variables) globally or per-job in the [`variables`](#variables) section.
section or the [`variables`](#job-variables) section for individual jobs.
There are three possible values: `none`, `normal`, and `recursive`: There are three possible values: `none`, `normal`, and `recursive`:
...@@ -1336,8 +1288,36 @@ Note that for this feature to work correctly, the submodules must be configured ...@@ -1336,8 +1288,36 @@ Note that for this feature to work correctly, the submodules must be configured
- a relative path to another repository on the same GitLab server. See the - a relative path to another repository on the same GitLab server. See the
[Git submodules](../git_submodules.md) documentation. [Git submodules](../git_submodules.md) documentation.
### Git checkout
> Introduced in GitLab Runner 9.3
The `GIT_CHECKOUT` variable can be used when the `GIT_STRATEGY` is set to either
`clone` or `fetch` to specify whether a `git checkout` should be run. If not
specified, it defaults to true. You can set them globally or per-job in the
[`variables`](#variables) section.
If set to `false`, the Runner will:
- when doing `fetch` - update the repository and leave working copy on
the current revision,
- when doing `clone` - clone the repository and leave working copy on the
default branch.
Having this setting set to `true` will mean that for both `clone` and `fetch`
strategies the Runner will checkout the working copy to a revision related
to the CI pipeline:
```yaml
variables:
GIT_STRATEGY: clone
GIT_CHECKOUT: "false"
script:
- git checkout master
- git merge $CI_BUILD_REF_NAME
```
## Job stages attempts ### Job stages attempts
> Introduced in GitLab, it requires GitLab Runner v1.9+. > Introduced in GitLab, it requires GitLab Runner v1.9+.
...@@ -1359,10 +1339,9 @@ variables: ...@@ -1359,10 +1339,9 @@ variables:
GET_SOURCES_ATTEMPTS: 3 GET_SOURCES_ATTEMPTS: 3
``` ```
You can set them in the global [`variables`](#variables) section or the You can set them globally or per-job in the [`variables`](#variables) section.
[`variables`](#job-variables) section for individual jobs.
## Shallow cloning ### Shallow cloning
> Introduced in GitLab 8.9 as an experimental feature. May change in future > Introduced in GitLab 8.9 as an experimental feature. May change in future
releases or be removed completely. releases or be removed completely.
...@@ -1393,7 +1372,17 @@ variables: ...@@ -1393,7 +1372,17 @@ variables:
GIT_DEPTH: "3" GIT_DEPTH: "3"
``` ```
## Hidden keys (jobs) You can set it globally or per-job in the [`variables`](#variables) section.
## Special YAML features
It's possible to use special YAML features like anchors (`&`), aliases (`*`)
and map merging (`<<`), which will allow you to greatly reduce the complexity
of `.gitlab-ci.yml`.
Read more about the various [YAML features](https://learnxinyminutes.com/docs/yaml/).
### Hidden keys (jobs)
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1. > Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
...@@ -1419,14 +1408,6 @@ Use this feature to ignore jobs, or use the ...@@ -1419,14 +1408,6 @@ Use this feature to ignore jobs, or use the
[special YAML features](#special-yaml-features) and transform the hidden keys [special YAML features](#special-yaml-features) and transform the hidden keys
into templates. into templates.
## Special YAML features
It's possible to use special YAML features like anchors (`&`), aliases (`*`)
and map merging (`<<`), which will allow you to greatly reduce the complexity
of `.gitlab-ci.yml`.
Read more about the various [YAML features](https://learnxinyminutes.com/docs/yaml/).
### Anchors ### Anchors
> Introduced in GitLab 8.6 and GitLab Runner v1.1.1. > Introduced in GitLab 8.6 and GitLab Runner v1.1.1.
...@@ -1556,34 +1537,10 @@ with an API call. ...@@ -1556,34 +1537,10 @@ with an API call.
[Read more in the triggers documentation.](../triggers/README.md) [Read more in the triggers documentation.](../triggers/README.md)
### pages ## Skipping jobs
`pages` is a special job that is used to upload static content to GitLab that
can be used to serve your website. It has a special syntax, so the two
requirements below must be met:
1. Any static content must be placed under a `public/` directory
1. `artifacts` with a path to the `public/` directory must be defined
The example below simply moves all files from the root of the project to the
`public/` directory. The `.public` workaround is so `cp` doesn't also copy
`public/` to itself in an infinite loop:
```
pages:
stage: deploy
script:
- mkdir .public
- cp -r * .public
- mv .public public
artifacts:
paths:
- public
only:
- master
```
Read more on [GitLab Pages user documentation](../../user/project/pages/index.md). If your commit message contains `[ci skip]` or `[skip ci]`, using any
capitalization, the commit will be created but the pipeline will be skipped.
## Validate the .gitlab-ci.yml ## Validate the .gitlab-ci.yml
...@@ -1595,11 +1552,6 @@ You can find the link under `/ci/lint` of your gitlab instance. ...@@ -1595,11 +1552,6 @@ You can find the link under `/ci/lint` of your gitlab instance.
If you get validation error when using specific values (e.g., `true` or `false`), If you get validation error when using specific values (e.g., `true` or `false`),
try to quote them, or change them to a different form (e.g., `/bin/true`). try to quote them, or change them to a different form (e.g., `/bin/true`).
## Skipping jobs
If your commit message contains `[ci skip]` or `[skip ci]`, using any
capitalization, the commit will be created but the jobs will be skipped.
## Examples ## Examples
Visit the [examples README][examples] to see a list of examples using GitLab Visit the [examples README][examples] to see a list of examples using GitLab
......
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