Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
967540d9
Commit
967540d9
authored
Feb 15, 2021
by
Evan Read
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch 'docs-triggers-build-terminology' into 'master'
Modernize vocab in triggers doc See merge request gitlab-org/gitlab!54195
parents
bd4937e2
e1b19dff
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
11 additions
and
13 deletions
+11
-13
doc/ci/triggers/README.md
doc/ci/triggers/README.md
+11
-13
doc/ci/triggers/img/builds_page.png
doc/ci/triggers/img/builds_page.png
+0
-0
doc/ci/triggers/img/trigger_single_job.png
doc/ci/triggers/img/trigger_single_job.png
+0
-0
No files found.
doc/ci/triggers/README.md
View file @
967540d9
...
@@ -53,7 +53,7 @@ and it creates a dependent pipeline relation visible on the
...
@@ -53,7 +53,7 @@ and it creates a dependent pipeline relation visible on the
[
pipeline graph
](
../multi_project_pipelines.md
)
. For example:
[
pipeline graph
](
../multi_project_pipelines.md
)
. For example:
```
yaml
```
yaml
build_docs
:
trigger_pipeline
:
stage
:
deploy
stage
:
deploy
script
:
script
:
-
curl --request POST --form "token=$CI_JOB_TOKEN" --form ref=master "https://gitlab.example.com/api/v4/projects/9/trigger/pipeline"
-
curl --request POST --form "token=$CI_JOB_TOKEN" --form ref=master "https://gitlab.example.com/api/v4/projects/9/trigger/pipeline"
...
@@ -126,16 +126,14 @@ branches or tags. The `:id` of a project can be found by
...
@@ -126,16 +126,14 @@ branches or tags. The `:id` of a project can be found by
[
querying the API
](
../../api/projects.md
)
or by visiting the
**CI/CD**
[
querying the API
](
../../api/projects.md
)
or by visiting the
**CI/CD**
settings page which provides self-explanatory examples.
settings page which provides self-explanatory examples.
When a rerun of a pipeline is triggered,
the information is exposed in the GitLab
When a rerun of a pipeline is triggered,
jobs are marked as triggered
`by API`
in
UI under the
**Jobs**
page and the jobs are marked as triggered 'by API'
.
**CI/CD > Jobs**
.
![
Marked rebuilds as on jobs page
](
img/builds_page.png
)
You can see which trigger caused a job to run by visiting the single job page.
You can see which trigger caused the rebuild by visiting the single job page.
A part of the trigger's token is exposed in the UI as you can see from the image
A part of the trigger's token is exposed in the UI as you can see from the image
below.
below.
![
Marked
rebuilds as triggered on a single job page
](
img/trigger_single_build
.png
)
![
Marked
as triggered on a single job page
](
img/trigger_single_job
.png
)
By using cURL you can trigger a pipeline rerun with minimal effort, for example:
By using cURL you can trigger a pipeline rerun with minimal effort, for example:
...
@@ -146,7 +144,7 @@ curl --request POST \
...
@@ -146,7 +144,7 @@ curl --request POST \
"https://gitlab.example.com/api/v4/projects/9/trigger/pipeline"
"https://gitlab.example.com/api/v4/projects/9/trigger/pipeline"
```
```
In this case, the p
roject with ID
`9`
gets rebuilt on
`master`
branch.
In this case, the p
ipeline for the project with ID
`9`
runs on the
`master`
branch.
Alternatively, you can pass the
`token`
and
`ref`
arguments in the query string:
Alternatively, you can pass the
`token`
and
`ref`
arguments in the query string:
...
@@ -156,12 +154,12 @@ curl --request POST \
...
@@ -156,12 +154,12 @@ curl --request POST \
```
```
You can also benefit by using triggers in your
`.gitlab-ci.yml`
. Let's say that
You can also benefit by using triggers in your
`.gitlab-ci.yml`
. Let's say that
you have two projects, A and B, and you want to trigger a
rebuild
on the
`master`
you have two projects, A and B, and you want to trigger a
pipeline
on the
`master`
branch of project B whenever a tag on project A is created. This is the job you
branch of project B whenever a tag on project A is created. This is the job you
need to add in project A's
`.gitlab-ci.yml`
:
need to add in project A's
`.gitlab-ci.yml`
:
```
yaml
```
yaml
build_docs
:
trigger_pipeline
:
stage
:
deploy
stage
:
deploy
script
:
script
:
-
'
curl
--request
POST
--form
token=TOKEN
--form
ref=master
"https://gitlab.example.com/api/v4/projects/9/trigger/pipeline"'
-
'
curl
--request
POST
--form
token=TOKEN
--form
ref=master
"https://gitlab.example.com/api/v4/projects/9/trigger/pipeline"'
...
@@ -170,7 +168,7 @@ build_docs:
...
@@ -170,7 +168,7 @@ build_docs:
```
```
This means that whenever a new tag is pushed on project A, the job runs and the
This means that whenever a new tag is pushed on project A, the job runs and the
`
build_docs`
job is executed, triggering a rebuild of
project B. The
`
trigger_pipeline`
job is executed, triggering the pipeline for
project B. The
`stage: deploy`
ensures that this job runs only after all jobs with
`stage: deploy`
ensures that this job runs only after all jobs with
`stage: test`
complete successfully.
`stage: test`
complete successfully.
...
@@ -204,7 +202,7 @@ This information is also exposed in the UI. Please note that _values_ are only v
...
@@ -204,7 +202,7 @@ This information is also exposed in the UI. Please note that _values_ are only v
Using trigger variables can be proven useful for a variety of reasons:
Using trigger variables can be proven useful for a variety of reasons:
-
Identifiable jobs. Since the variable is exposed in the UI you can know
-
Identifiable jobs. Since the variable is exposed in the UI you can know
why the
rebuild
was triggered if you pass a variable that explains the
why the
pipeline
was triggered if you pass a variable that explains the
purpose.
purpose.
-
Conditional job processing. You can have conditional jobs that run whenever
-
Conditional job processing. You can have conditional jobs that run whenever
a certain variable is present.
a certain variable is present.
...
@@ -236,7 +234,7 @@ upload_package:
...
@@ -236,7 +234,7 @@ upload_package:
-
if [ -n "${UPLOAD_TO_S3}" ]; then make upload; fi
-
if [ -n "${UPLOAD_TO_S3}" ]; then make upload; fi
```
```
You can then trigger a
rebuild
while you pass the
`UPLOAD_TO_S3`
variable
You can then trigger a
pipeline
while you pass the
`UPLOAD_TO_S3`
variable
and the script of the
`upload_package`
job is run:
and the script of the
`upload_package`
job is run:
```
shell
```
shell
...
...
doc/ci/triggers/img/builds_page.png
deleted
100644 → 0
View file @
bd4937e2
19.9 KB
doc/ci/triggers/img/trigger_single_
build
.png
→
doc/ci/triggers/img/trigger_single_
job
.png
View file @
967540d9
File moved
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment