From 31e0dee3b853ba737ba01a775cb4be3bcd0b90f2 Mon Sep 17 00:00:00 2001 From: Grzegorz Bizon Date: Thu, 18 Feb 2016 14:46:31 +0100 Subject: Add documentation about build emails service Closes #12497 --- doc/ci/quick_start/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'doc/ci') diff --git a/doc/ci/quick_start/README.md b/doc/ci/quick_start/README.md index ae7b760fa67..0bd2f797c6f 100644 --- a/doc/ci/quick_start/README.md +++ b/doc/ci/quick_start/README.md @@ -184,6 +184,22 @@ you expected. You are also able to view the status of any commit in the various pages in GitLab, such as **Commits** and **Merge Requests**. +## Enabling build emails + +If you want to recieve notifications about builds (when build fails, for +example), you should enable **Build Emails Service**. + +**Build Emails** service is available on a **Service** page in a project's +settings. You should activate it by checking an *Active* checkbox, and clicking +"Save changes". + +Note that you can also provide a list of recipients that will always recieve +notifications or indicate that you want a pusher to also recieve notification +about each build's status. + +If you decide to check *Notify only broken builds* checkbox, notifications will +be sent only for failed builds. + ## Builds badge You can access a builds badge image using following link: -- cgit v1.2.1 From 7f5f56d4433b22ed45c5c62ab61f3e27c7480029 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Fri, 19 Feb 2016 23:17:28 +0200 Subject: Move builds emails service to its own document [ci skip] --- doc/ci/quick_start/README.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) (limited to 'doc/ci') diff --git a/doc/ci/quick_start/README.md b/doc/ci/quick_start/README.md index 0bd2f797c6f..07e566e3710 100644 --- a/doc/ci/quick_start/README.md +++ b/doc/ci/quick_start/README.md @@ -36,13 +36,13 @@ file and start builds on _Runners_ according to the contents of the file, for that commit. Because `.gitlab-ci.yml` is in the repository, it is version controlled, -old versions still build succesfully, forks can easily make use of CI, +old versions still build successfully, forks can easily make use of CI, branches can have separate builds and you have a single source of truth for CI. You can read more about the reasons why we are using `.gitlab-ci.yml` [in our blog about it][blog-ci]. **Note:** `.gitlab-ci.yml` is a [YAML](https://en.wikipedia.org/wiki/YAML) file -so you have to pay extra attention to the identation. Always use spaces, not +so you have to pay extra attention to the indentation. Always use spaces, not tabs. ### Creating a simple `.gitlab-ci.yml` file @@ -168,7 +168,7 @@ To enable **Shared Runners** you have to go to your project's ## Seeing the status of your build -After configuring the Runner succesfully, you should see the status of your +After configuring the Runner successfully, you should see the status of your last commit change from _pending_ to either _running_, _success_ or _failed_. You can view all builds, by going to the **Builds** page in your project. @@ -186,19 +186,12 @@ GitLab, such as **Commits** and **Merge Requests**. ## Enabling build emails -If you want to recieve notifications about builds (when build fails, for -example), you should enable **Build Emails Service**. +If you want to receive e-mail notifications about the result status of the +builds, you should explicitly enable the **Builds Emails** service under your +project's settings. -**Build Emails** service is available on a **Service** page in a project's -settings. You should activate it by checking an *Active* checkbox, and clicking -"Save changes". - -Note that you can also provide a list of recipients that will always recieve -notifications or indicate that you want a pusher to also recieve notification -about each build's status. - -If you decide to check *Notify only broken builds* checkbox, notifications will -be sent only for failed builds. +For more information read the [Builds emails service documentation] +(../../project_services/builds_emails.md). ## Builds badge -- cgit v1.2.1