diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-12-01 14:43:13 +0300 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-12-01 14:43:13 +0300 |
| commit | 42dc2033dd4f04203c6f025ee96a058e050c9312 (patch) | |
| tree | 957d23de0c460cd8c36aae1e6ef621c55975568a | |
| parent | 63d45dc4ba2623500b7757bd903337248c26c5c7 (diff) | |
| parent | dd7f0fb687b2507c0f45b772bc2a4465650e5a7b (diff) | |
Merge branch 'docs/triggers-ref-clarify' into 'master'
Clarify that a commit SHA doesn't work for CI triggers
Related https://gitlab.com/gitlab-org/gitlab-ce/issues/22029
See merge request !7871
| -rw-r--r-- | doc/ci/triggers/README.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/ci/triggers/README.md b/doc/ci/triggers/README.md index cf7c55f75f2..efca05af7b8 100644 --- a/doc/ci/triggers/README.md +++ b/doc/ci/triggers/README.md @@ -6,7 +6,7 @@ GitLab 8.12 has a completely redesigned build permissions system. Read all about the [new model and its implications](../../user/project/new_ci_build_permissions_model.md#build-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 `ref` (branch or tag) with an API call. ## Add a trigger @@ -29,6 +29,10 @@ irreversible. ## Trigger a build +> **Note**: +Valid refs are only the branches and tags. If you pass a commit SHA as a ref, +it will not trigger a build. + To trigger a build you need to send a `POST` request to GitLab's API endpoint: ``` @@ -36,8 +40,8 @@ POST /projects/:id/trigger/builds ``` The required parameters are the trigger's `token` and the Git `ref` on which -the trigger will be performed. Valid refs are the branch, the tag or the commit -SHA. The `:id` of a project can be found by [querying the API](../../api/projects.md) +the trigger will be performed. Valid refs are the branch and the tag. The `:id` +of a project can be found by [querying the API](../../api/projects.md) or by visiting the **Triggers** page which provides self-explanatory examples. When a rebuild is triggered, the information is exposed in GitLab's UI under |