summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2015-12-21 20:41:51 +0200
committerAchilleas Pipinellis <axilleas@axilleas.me>2015-12-21 20:41:51 +0200
commitd5e9436033d75da74c40ced450e060c8a5c307f9 (patch)
tree39f3fe61fd572c65c4094c43da62747d91c3b209
parent33ef13c641a63c4c82c5867a6f01a90c57f3aa04 (diff)
downloadgitlab-ce-d5e9436033d75da74c40ced450e060c8a5c307f9.tar.gz
Document triggers in yaml/README.md [ci skip]
-rw-r--r--doc/ci/yaml/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md
index fd0d49de4e4..6862116cc5b 100644
--- a/doc/ci/yaml/README.md
+++ b/doc/ci/yaml/README.md
@@ -66,6 +66,7 @@ There are a few reserved `keywords` that **cannot** be used as job names:
| before_script | no | Define commands that run before each job's script |
| variables | no | Define build variables |
| cache | no | Define list of files that should be cached between subsequent runs |
+| trigger | no | Force a rebuild of a specific branch or tag with an API call |
### image and services
@@ -152,6 +153,32 @@ cache:
- binaries/
```
+### trigger
+
+Triggers can be used to force a rebuild of a specific branch or tag with an API
+call. You can add a trigger by visiting the project's **Settings > Triggers**.
+
+Every new trigger you create, gets assigned a different token which you can
+then use inside your `.gitlab-ci.yml`:
+
+```yaml
+trigger:
+ stage: deploy
+ script:
+ - "curl -X POST -F token=TOKEN -F ref=master https://gitlab.com/api/v3/projects/9/trigger/builds"
+```
+
+In the example above, a rebuild on master branch will be triggered after all
+previous stages build successfully (denoted by `stage: deploy`).
+
+You can find the endpoint containing the ID of the project on the **Triggers**
+page.
+
+_**Warning:** Be careful how you set up your triggers, because you could end up
+in an infinite loop._
+
+Read more in the dedicated [triggers documentation](../triggers/README.md).
+
## Jobs
`.gitlab-ci.yml` allows you to specify an unlimited number of jobs. Each job