summaryrefslogtreecommitdiff
path: root/doc/ci
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-02-19 21:36:47 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-02-19 21:36:47 +0000
commit2cc9a42ca45d14fc7fe35ea6f8bc4f9275f33144 (patch)
treed464d8ecaa7a9719165af454cdbe11f99f5893ae /doc/ci
parentde84fa365eff85a3d21a664f24e9832a664c10c9 (diff)
parent7f5f56d4433b22ed45c5c62ab61f3e27c7480029 (diff)
downloadgitlab-ce-2cc9a42ca45d14fc7fe35ea6f8bc4f9275f33144.tar.gz
Merge branch 'doc/add-build-email-service' into 'master'
Add documentation about build emails service Closes #12497 See merge request !2871
Diffstat (limited to 'doc/ci')
-rw-r--r--doc/ci/quick_start/README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/ci/quick_start/README.md b/doc/ci/quick_start/README.md
index ae7b760fa67..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.
@@ -184,6 +184,15 @@ 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 receive e-mail notifications about the result status of the
+builds, you should explicitly enable the **Builds Emails** service under your
+project's settings.
+
+For more information read the [Builds emails service documentation]
+(../../project_services/builds_emails.md).
+
## Builds badge
You can access a builds badge image using following link: