Commit 883e8f86 authored by Grzegorz Bizon's avatar Grzegorz Bizon

Add basic docs for CI/CD job auto-retry feature

parent 67157d81
...@@ -395,6 +395,7 @@ job_name: ...@@ -395,6 +395,7 @@ job_name:
| after_script | no | Override a set of commands that are executed after 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 | | 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 | | 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 ### script
...@@ -1129,9 +1130,33 @@ A simple example: ...@@ -1129,9 +1130,33 @@ A simple example:
```yaml ```yaml
job1: job1:
script: rspec
coverage: '/Code coverage: \d+\.\d+/' coverage: '/Code coverage: \d+\.\d+/'
``` ```
### retry
**Notes:**
- [Introduced][ce-3442] in GitLab 9.5.
`retry` allows you to configure how many times a job is going to be retried in
case of a failure.
When a job fails, and has `retry` configured it is going to be processed again
up to the amount of times specified by the `retry` keyword.
If `retry` is set to 3, and a job succeeds in a second run, it won't be retried
again. `retry` value has to be a positive integer, equal or larger than 0, but
lower than 10.
A simple example:
```yaml
test:
script: rspec
retry: 3
```
## Git Strategy ## 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
...@@ -1506,3 +1531,4 @@ CI with various languages. ...@@ -1506,3 +1531,4 @@ CI with various languages.
[variables]: ../variables/README.md [variables]: ../variables/README.md
[ce-7983]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7983 [ce-7983]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7983
[ce-7447]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7447 [ce-7447]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/7447
[ce-3442]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3442
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