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
c9d475aa
Commit
c9d475aa
authored
Sep 12, 2020
by
VidyaSrivatsan
Committed by
Marcel Amirault
Sep 23, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Readme updated based on linting standard
parent
d397478d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
11 additions
and
11 deletions
+11
-11
doc/ci/triggers/README.md
doc/ci/triggers/README.md
+11
-11
No files found.
doc/ci/triggers/README.md
View file @
c9d475aa
...
@@ -95,9 +95,9 @@ Read more about the [jobs API](../../api/job_artifacts.md#download-the-artifacts
...
@@ -95,9 +95,9 @@ Read more about the [jobs API](../../api/job_artifacts.md#download-the-artifacts
## Adding a new trigger
## Adding a new trigger
You can add a new trigger by going to your project's
Go to your
**Settings ➔ CI/CD**
under
**Triggers**
. The
**Add trigger**
button will
**Settings ➔ CI/CD**
under
**Triggers**
to add a new trigger. The
**Add trigger**
button creates
create
a new token which you can then use to trigger a rerun of this
a new token which you can then use to trigger a rerun of this
particular project's pipeline.
particular project's pipeline.
Every new trigger you create, gets assigned a different token which you can
Every new trigger you create, gets assigned a different token which you can
...
@@ -121,7 +121,7 @@ POST /projects/:id/trigger/pipeline
...
@@ -121,7 +121,7 @@ POST /projects/:id/trigger/pipeline
```
```
The required parameters are the
[
trigger's `token`
](
#authentication-tokens
)
The required parameters are the
[
trigger's `token`
](
#authentication-tokens
)
and the Git
`ref`
on which the trigger
will be
performed. Valid refs are
and the Git
`ref`
on which the trigger
is
performed. Valid refs are
branches or tags. The
`:id`
of a project can be found by
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.
...
@@ -146,7 +146,7 @@ curl --request POST \
...
@@ -146,7 +146,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 project with ID
`9`
will get
rebuilt on
`master`
branch.
In this case, the project with ID
`9`
gets
rebuilt on
`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:
...
@@ -169,9 +169,9 @@ build_docs:
...
@@ -169,9 +169,9 @@ build_docs:
-
tags
-
tags
```
```
This means that whenever a new tag is pushed on project A, the job
will run
and the
This means that whenever a new tag is pushed on project A, the job
runs
and the
`build_docs`
job
will be
executed, triggering a rebuild of project B. The
`build_docs`
job
is
executed, triggering a rebuild of project B. The
`stage: deploy`
ensures that this job
will run
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.
## Triggering a pipeline from a webhook
## Triggering a pipeline from a webhook
...
@@ -190,7 +190,7 @@ trigger in the source repository. `ref` should be URL-encoded if it contains sla
...
@@ -190,7 +190,7 @@ trigger in the source repository. `ref` should be URL-encoded if it contains sla
## Making use of trigger variables
## Making use of trigger variables
You can pass any number of arbitrary variables in the trigger API call and they
You can pass any number of arbitrary variables in the trigger API call and they
will b
e available in GitLab CI/CD so that they can be used in your
`.gitlab-ci.yml`
ar
e available in GitLab CI/CD so that they can be used in your
`.gitlab-ci.yml`
file. The parameter is of the form:
file. The parameter is of the form:
```
plaintext
```
plaintext
...
@@ -237,7 +237,7 @@ upload_package:
...
@@ -237,7 +237,7 @@ upload_package:
```
```
You can then trigger a rebuild while you pass the
`UPLOAD_TO_S3`
variable
You can then trigger a rebuild while you pass the
`UPLOAD_TO_S3`
variable
and the script of the
`upload_package`
job
will
run:
and the script of the
`upload_package`
job
is
run:
```
shell
```
shell
curl
--request
POST
\
curl
--request
POST
\
...
@@ -266,7 +266,7 @@ branch of project with ID `9` every night at `00:30`:
...
@@ -266,7 +266,7 @@ branch of project with ID `9` every night at `00:30`:
## Legacy triggers
## Legacy triggers
Old triggers, created before GitLab 9.0
will b
e marked as legacy.
Old triggers, created before GitLab 9.0
ar
e marked as legacy.
Triggers with the legacy label do not have an associated user and only have
Triggers with the legacy label do not have an associated user and only have
access to the current project. They are considered deprecated and will be
access to the current project. They are considered deprecated and will be
...
...
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