Commit af8321c9 authored by Grzegorz Bizon's avatar Grzegorz Bizon

Copy-edit documentation for cross-project triggers

parent 2fe30dc7
...@@ -41,18 +41,18 @@ together, allowing you to visualize their relationships on pipeline graphs. ...@@ -41,18 +41,18 @@ together, allowing you to visualize their relationships on pipeline graphs.
These relationships are displayed in the pipeline graph by showing inbound and These relationships are displayed in the pipeline graph by showing inbound and
outbound connections for upstream and downstream pipeline dependencies. outbound connections for upstream and downstream pipeline dependencies.
## Creating cross-project pipeline from .gitlab-ci.yml ## Creating cross-project pipelines from .gitlab-ci.yml
> Introduced in GitLab 11.8 > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8997) in in [GitLab Premium](https://about.gitlab.com/pricing/) 11.8.
### Triggering a downstream pipeline using a bridge job ### Triggering a downstream pipeline using a bridge job
Before GitLab 11.8 it was necessary to implement a pipeline job that was Before GitLab 11.8, it was necessary to implement a pipeline job that was
responsible for making the API request [to trigger a pipeline](triggers/README.md#creating-cross-project-pipeline-through-API) responsible for making the API request [to trigger a pipeline](triggers/README.md#creating-cross-project-pipeline-through-API)
in a different project. in a different project.
In GitLab 11.8, GitLab provides a new CI/CD configuration syntax to make this In GitLab 11.8, GitLab provides a new CI/CD configuration syntax to make this
task easier, and avoid needing GitLab Runner for triggering a cross-project task easier, and avoid needing GitLab Runner for triggering cross-project
pipelines. pipelines.
```yaml ```yaml
...@@ -67,11 +67,11 @@ staging: ...@@ -67,11 +67,11 @@ staging:
trigger: my/deployment trigger: my/deployment
``` ```
In the example above, as soon as `rspec` job succeeds in stage `test`, In the example above, as soon as `rspec` job succeeds in the `test` stage,
`staging` "bridge" job is going to be started. Initial status of this job is the `staging` "bridge" job is going to be started. The initial status of this
going to be `pending`. GitLab will create a downstream pipeline in the job will be `pending`. GitLab will create a downstream pipeline in the
`my/deployment` project and as soon as the pipeline gets created, the `staging` `my/deployment` project and, as soon as the pipeline gets created, the
job will succeed. `my/deployment` is a full path to that project. `staging` job will succeed. `my/deployment` is a full path to that project.
The user that created the upstream pipeline needs to have access rights to the The user that created the upstream pipeline needs to have access rights to the
downstream project (`my/deployment` in this case). If a downstream project can downstream project (`my/deployment` in this case). If a downstream project can
...@@ -81,7 +81,7 @@ the `staging` job is going to be marked as _failed_. ...@@ -81,7 +81,7 @@ the `staging` job is going to be marked as _failed_.
Caution: **Caution:** Caution: **Caution:**
`staging` will succeed as soon as a downstream pipeline gets created. `staging` will succeed as soon as a downstream pipeline gets created.
GitLab does not support status attribution yet, however adding first-class GitLab does not support status attribution yet, however adding first-class
`trigger` configuration syntax is a ground work for implementing `trigger` configuration syntax is ground work for implementing
[status attribution](https://gitlab.com/gitlab-org/gitlab-ce/issues/39640). [status attribution](https://gitlab.com/gitlab-org/gitlab-ce/issues/39640).
NOTE: **Note:** NOTE: **Note:**
...@@ -108,7 +108,7 @@ staging: ...@@ -108,7 +108,7 @@ staging:
``` ```
Use a `project` keyword to specify full path to a downstream project. Use Use a `project` keyword to specify full path to a downstream project. Use
`branch` keyword to specify a branch name. a `branch` keyword to specify a branch name.
GitLab will use a commit that is currently on the HEAD of the branch when GitLab will use a commit that is currently on the HEAD of the branch when
creating a downstream pipeline. creating a downstream pipeline.
......
...@@ -1533,13 +1533,13 @@ test: ...@@ -1533,13 +1533,13 @@ test:
## `trigger` ## `trigger`
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8997) in GitLab 11.8. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/8997) in in [GitLab Premium](https://about.gitlab.com/pricing/) 11.8.
`trigger` allows you to define downstream pipeline trigger. When a job created `trigger` allows you to define downstream pipeline trigger. When a job created
from `trigger` definition is started by GitLab, a downstream pipeline gets from `trigger` definition is started by GitLab, a downstream pipeline gets
created. created.
Learm more about that from documentation about [multi-project pipelines](../multi_project_pipelines.html#creating-cross-project-pipeline-from-gitlab-ci-yml). Learm more about [multi-project pipelines](../multi_project_pipelines.html#creating-cross-project-pipelines-from-gitlab-ci-yml).
Example: Example:
...@@ -2353,7 +2353,9 @@ You can see that the hidden keys are conveniently used as templates. ...@@ -2353,7 +2353,9 @@ You can see that the hidden keys are conveniently used as templates.
## Triggers ## Triggers
Triggers can be used to force a rebuild of a specific branch, tag or commit, Triggers can be used to force a rebuild of a specific branch, tag or commit,
with an API call. with an API call when a pipeline gets created using a trigger token.
Not to be confused with [`trigger`](#trigger).
[Read more in the triggers documentation.](../triggers/README.md) [Read more in the triggers documentation.](../triggers/README.md)
......
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