diff options
| author | Kamil Trzcinski <ayufan@ayufan.eu> | 2015-08-04 20:37:48 +0200 |
|---|---|---|
| committer | Kamil Trzcinski <ayufan@ayufan.eu> | 2015-08-04 20:37:48 +0200 |
| commit | bbfe09480c58d79d4b58c83ef6c202c9ccb282dc (patch) | |
| tree | b9af4c2cb7a629f94064288a4918762cc32970d4 /doc | |
| parent | 598243c072d94087afe459dad12b9448d45e028f (diff) | |
| download | gitlab-ci-bbfe09480c58d79d4b58c83ef6c202c9ccb282dc.tar.gz | |
Fix documentationrename-type-to-stage
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/yaml/README.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/yaml/README.md b/doc/yaml/README.md index 08f9df4..301144a 100644 --- a/doc/yaml/README.md +++ b/doc/yaml/README.md @@ -52,8 +52,8 @@ There are a few `keywords` that can't be used as job names: |---------------|----------|-------------| | image | optional | Use docker image, covered in [Use Docker](../docker/README.md) | | services | optional | Use docker services, covered in [Use Docker](../docker/README.md) | -| stage | optional | Define build stages | -| types | optional | Alias for `types` | +| stages | optional | Define build stages | +| types | optional | Alias for `stages` | | before_script | optional | Define commands prepended for each job's script | ### image and services @@ -72,7 +72,7 @@ The ordering of elements in `stages` defines the ordering of builds' execution: 1. Builds of the same stage are run in parallel. 1. Builds of next stage are run after success. -Let's consider the following example, which defines 3 types: +Let's consider the following example, which defines 3 stages: ``` stages: - build @@ -84,11 +84,11 @@ stages: 1. If all jobs of `build` succeeds, the `test` jobs are executed in parallel. 1. If all jobs of `test` succeeds, the `deploy` jobs are executed in parallel. 1. If all jobs of `deploy` succeeds, the commit is marked as `success`. -1. If any of the previous jobs fails, the commit is marked as `failed` and no jobs of further type are executed. +1. If any of the previous jobs fails, the commit is marked as `failed` and no jobs of further stage are executed. There are also two edge cases worth mentioning: -1. If no `stages` is defined in `.gitlab-ci.yml`, then the types `build`, `test` and `deploy` are allowed to be used as job's stage by default. +1. If no `stages` is defined in `.gitlab-ci.yml`, then by default the `build`, `test` and `deploy` are allowed to be used as job's stage by default. 2. If a job doesn't specify `stage`, the job is assigned the `test` stage. ### types |