Add pipeline image
This commit is contained in:
parent
a0fefc2ad2
commit
a1c2b16837
2 changed files with 23 additions and 19 deletions
|
@ -9,8 +9,9 @@ GitLab offers a [continuous integration][ci] service. If you
|
||||||
and configure your GitLab project to use a [Runner], then each merge request or
|
and configure your GitLab project to use a [Runner], then each merge request or
|
||||||
push triggers your CI [pipeline].
|
push triggers your CI [pipeline].
|
||||||
|
|
||||||
The `.gitlab-ci.yml` file tells the GitLab runner what to do. By default it
|
The `.gitlab-ci.yml` file tells the GitLab runner what to do. By default it runs
|
||||||
runs a pipeline with three [stages]: `build`, `test`, and `deploy`.
|
a pipeline with three [stages]: `build`, `test`, and `deploy`. You don't need to
|
||||||
|
use all three stages; stages with no jobs are simply ignored.
|
||||||
|
|
||||||
If everything runs OK (no non-zero return values), you'll get a nice green
|
If everything runs OK (no non-zero return values), you'll get a nice green
|
||||||
checkmark associated with the pushed commit or merge request. This makes it
|
checkmark associated with the pushed commit or merge request. This makes it
|
||||||
|
@ -56,15 +57,14 @@ On any push to your repository, GitLab will look for the `.gitlab-ci.yml`
|
||||||
file and start builds on _Runners_ according to the contents of the file,
|
file and start builds on _Runners_ according to the contents of the file,
|
||||||
for that commit.
|
for that commit.
|
||||||
|
|
||||||
Because `.gitlab-ci.yml` is in the repository, it is version controlled,
|
Because `.gitlab-ci.yml` is in the repository and is version controlled, old
|
||||||
old versions still build successfully, forks can easily make use of CI,
|
versions still build successfully, forks can easily make use of CI, branches can
|
||||||
branches can have separate builds and you have a single source of truth for CI.
|
have different pipelines and jobs, and you have a single source of truth for CI.
|
||||||
You can read more about the reasons why we are using `.gitlab-ci.yml`
|
You can read more about the reasons why we are using `.gitlab-ci.yml` [in our
|
||||||
[in our blog about it][blog-ci].
|
blog about it][blog-ci].
|
||||||
|
|
||||||
**Note:** `.gitlab-ci.yml` is a [YAML](https://en.wikipedia.org/wiki/YAML) file
|
**Note:** `.gitlab-ci.yml` is a [YAML](https://en.wikipedia.org/wiki/YAML) file
|
||||||
so you have to pay extra attention to the indentation. Always use spaces, not
|
so you have to pay extra attention to indentation. Always use spaces, not tabs.
|
||||||
tabs.
|
|
||||||
|
|
||||||
### Creating a simple `.gitlab-ci.yml` file
|
### Creating a simple `.gitlab-ci.yml` file
|
||||||
|
|
||||||
|
@ -107,7 +107,7 @@ If you want to check whether your `.gitlab-ci.yml` file is valid, there is a
|
||||||
Lint tool under the page `/ci/lint` of your GitLab instance. You can also find
|
Lint tool under the page `/ci/lint` of your GitLab instance. You can also find
|
||||||
the link under **Settings > CI settings** in your project.
|
the link under **Settings > CI settings** in your project.
|
||||||
|
|
||||||
For more information and a complete `.gitlab-ci.yml` syntax, please check
|
For more information and a complete `.gitlab-ci.yml` syntax, please read
|
||||||
[the documentation on .gitlab-ci.yml](../yaml/README.md).
|
[the documentation on .gitlab-ci.yml](../yaml/README.md).
|
||||||
|
|
||||||
### Push `.gitlab-ci.yml` to GitLab
|
### Push `.gitlab-ci.yml` to GitLab
|
||||||
|
@ -121,7 +121,8 @@ git commit -m "Add .gitlab-ci.yml"
|
||||||
git push origin master
|
git push origin master
|
||||||
```
|
```
|
||||||
|
|
||||||
Now if you go to the **Builds** page you will see that the builds are pending.
|
Now if you go to the **Pipelines** page you will see that the pipeline is
|
||||||
|
pending.
|
||||||
|
|
||||||
You can also go to the **Commits** page and notice the little clock icon next
|
You can also go to the **Commits** page and notice the little clock icon next
|
||||||
to the commit SHA.
|
to the commit SHA.
|
||||||
|
@ -137,15 +138,14 @@ Notice that there are two jobs pending which are named after what we wrote in
|
||||||
`.gitlab-ci.yml`. The red triangle indicates that there is no Runner configured
|
`.gitlab-ci.yml`. The red triangle indicates that there is no Runner configured
|
||||||
yet for these builds.
|
yet for these builds.
|
||||||
|
|
||||||
The next step is to configure a Runner so that it picks the pending jobs.
|
The next step is to configure a Runner so that it picks the pending builds.
|
||||||
|
|
||||||
## Configuring a Runner
|
## Configuring a Runner
|
||||||
|
|
||||||
In GitLab, Runners run the builds that you define in `.gitlab-ci.yml`.
|
In GitLab, Runners run the builds that you define in `.gitlab-ci.yml`. A Runner
|
||||||
A Runner can be a virtual machine, a VPS, a bare-metal machine, a docker
|
can be a virtual machine, a VPS, a bare-metal machine, a docker container or
|
||||||
container or even a cluster of containers. GitLab and the Runners communicate
|
even a cluster of containers. GitLab and the Runners communicate through an API,
|
||||||
through an API, so the only needed requirement is that the machine on which the
|
so the only requirement is that the Runner's machine has Internet access.
|
||||||
Runner is configured to have Internet access.
|
|
||||||
|
|
||||||
A Runner can be specific to a certain project or serve multiple projects in
|
A Runner can be specific to a certain project or serve multiple projects in
|
||||||
GitLab. If it serves all projects it's called a _Shared Runner_.
|
GitLab. If it serves all projects it's called a _Shared Runner_.
|
||||||
|
@ -187,12 +187,16 @@ To enable **Shared Runners** you have to go to your project's
|
||||||
|
|
||||||
[Read more on Shared Runners](../runners/README.md).
|
[Read more on Shared Runners](../runners/README.md).
|
||||||
|
|
||||||
## Seeing the status of your build
|
## Seeing the status of your pipeline and builds
|
||||||
|
|
||||||
After configuring the Runner successfully, 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_.
|
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.
|
You can view all pipelines by going to the **Pipelines** page in your project.
|
||||||
|
|
||||||
|
![Commit status](img/pipelines_status.png)
|
||||||
|
|
||||||
|
Or you can view all builds, by going to the **Pipelines > Builds** page.
|
||||||
|
|
||||||
![Commit status](img/builds_status.png)
|
![Commit status](img/builds_status.png)
|
||||||
|
|
||||||
|
|
BIN
doc/ci/quick_start/img/pipelines_status.png
Normal file
BIN
doc/ci/quick_start/img/pipelines_status.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 87 KiB |
Loading…
Reference in a new issue