Commit ae1def2e authored by Suzanne Selhorn's avatar Suzanne Selhorn

Merge branch 'docs-stages-passive-voice' into 'master'

Clean up a few bits in the yaml reference doc

See merge request gitlab-org/gitlab!55827
parents 87d0251c 76bc5f59
...@@ -110,7 +110,7 @@ rspec 2.6: ...@@ -110,7 +110,7 @@ rspec 2.6:
## Global keywords ## Global keywords
Some keywords are not defined within a job. These keywords control pipeline behavior Some keywords are not defined in a job. These keywords control pipeline behavior
or import additional pipeline configuration: or import additional pipeline configuration:
| Keyword | Description | | Keyword | Description |
...@@ -709,8 +709,8 @@ You can use syntax in [`script`](README.md#script) sections to: ...@@ -709,8 +709,8 @@ You can use syntax in [`script`](README.md#script) sections to:
Use `stage` to define which stage a job runs in. Jobs in the same Use `stage` to define which stage a job runs in. Jobs in the same
`stage` can execute in parallel (subject to [certain conditions](#use-your-own-runners)). `stage` can execute in parallel (subject to [certain conditions](#use-your-own-runners)).
Jobs without a `stage` entry use the `test` stage by default. If [`stages`](#stages) Jobs without a `stage` entry use the `test` stage by default. If you do not define
is not defined in the pipeline, you can use the 5 default stages, which execute in [`stages`](#stages) in the pipeline, you can use the 5 default stages, which execute in
this order: this order:
- [`.pre`](#pre-and-post) - [`.pre`](#pre-and-post)
...@@ -1532,8 +1532,11 @@ job: ...@@ -1532,8 +1532,11 @@ job:
- branches - branches
``` ```
In the following example, `job` runs only for refs that are tagged, or if a build is In the following example, `job` runs only for:
explicitly requested by an API trigger or a [pipeline schedule](../pipelines/schedules.md):
- Git tags
- [Triggers](../triggers/README.md#trigger-token)
- [Scheduled pipelines](../pipelines/schedules.md)
```yaml ```yaml
job: job:
...@@ -2092,12 +2095,13 @@ build_job: ...@@ -2092,12 +2095,13 @@ build_job:
artifacts: true artifacts: true
``` ```
Downloading artifacts from jobs that are run in [`parallel:`](#parallel) is not supported. You can't download artifacts from jobs that run in [`parallel:`](#parallel).
To download artifacts between [parent-child pipelines](../parent_child_pipelines.md),
use [`needs:pipeline`](#artifact-downloads-to-child-pipelines).
To download artifacts between [parent-child pipelines](../parent_child_pipelines.md) use [`needs:pipeline`](#artifact-downloads-to-child-pipelines). You should not download artifacts from the same ref as a running pipeline. Concurrent
Downloading artifacts from the same ref as the currently running pipeline is not pipelines running on the same ref could override the artifacts.
recommended because artifacts could be overridden by concurrent pipelines running
on the same ref.
##### Artifact downloads to child pipelines ##### Artifact downloads to child pipelines
...@@ -2504,11 +2508,6 @@ You can't use variables defined in a `script` section. ...@@ -2504,11 +2508,6 @@ You can't use variables defined in a `script` section.
#### `environment:on_stop` #### `environment:on_stop`
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/22191) in GitLab 8.13.
> - Starting with GitLab 8.14, when you have an environment that has a stop action
> defined, GitLab automatically triggers a stop action when the associated
> branch is deleted.
Closing (stopping) environments can be achieved with the `on_stop` keyword Closing (stopping) environments can be achieved with the `on_stop` keyword
defined under `environment`. It declares a different job that runs to close the defined under `environment`. It declares a different job that runs to close the
environment. environment.
...@@ -2517,8 +2516,6 @@ Read the `environment:action` section for an example. ...@@ -2517,8 +2516,6 @@ Read the `environment:action` section for an example.
#### `environment:action` #### `environment:action`
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/22191) in GitLab 8.13.
Use the `action` keyword to specify jobs that prepare, start, or stop environments. Use the `action` keyword to specify jobs that prepare, start, or stop environments.
| **Value** | **Description** | | **Value** | **Description** |
...@@ -3459,8 +3456,7 @@ for more details. ...@@ -3459,8 +3456,7 @@ for more details.
### `retry` ### `retry`
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/3442) in GitLab 9.5. > [Introduced](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3515) in GitLab 11.5, you can control which failures to retry on.
> - [Behavior expanded](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3515) in GitLab 11.5 to control which failures to retry on.
Use `retry` to configure how many times a job is retried in Use `retry` to configure how many times a job is retried in
case of a failure. case of a failure.
......
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