Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Jérome Perrin
gitlab-ce
Commits
4392098e
Commit
4392098e
authored
Oct 17, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fully document the pipelines settings page
parent
fdd52a6b
Changes
5
Show whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
111 additions
and
40 deletions
+111
-40
doc/ci/README.md
doc/ci/README.md
+1
-0
doc/ci/pipelines.md
doc/ci/pipelines.md
+9
-40
doc/user/project/img/project_settings_list.png
doc/user/project/img/project_settings_list.png
+0
-0
doc/user/project/pipelines/img/pipelines_settings_badges.png
doc/user/project/pipelines/img/pipelines_settings_badges.png
+0
-0
doc/user/project/pipelines/settings.md
doc/user/project/pipelines/settings.md
+101
-0
No files found.
doc/ci/README.md
View file @
4392098e
...
...
@@ -19,4 +19,5 @@
-
[
Build permissions
](
../user/permissions.md#build-permissions
)
-
[
API
](
../api/ci/README.md
)
-
[
CI services (linked docker containers)
](
services/README.md
)
-
[
CI/CD pipelines settings
](
../user/project/pipelines/settings.md
)
-
[
**New CI build permissions model**
](
../user/project/new_ci_build_permissions_model.md
)
Read about what changed in GitLab 8.12 and how that affects your builds. There's a new way to access your Git submodules and LFS objects in builds.
doc/ci/pipelines.md
View file @
4392098e
...
...
@@ -5,9 +5,9 @@ Introduced in GitLab 8.8.
## Pipelines
A pipeline is a group of [builds]
that get executed in [stages]
\(
batches). All
of the builds in a stage are executed in parallel (if there are enough
concurrent [
r
unners]), and if they all succeed, the pipeline moves on to the
A pipeline is a group of
[
builds
]
[]
that get executed in
[
stages
][]
(batches).
All
of the builds in a stage are executed in parallel (if there are enough
concurrent [
R
unners]), and if they all succeed, the pipeline moves on to the
next stage. If one of the builds fails, the next stage is not (usually)
executed.
...
...
@@ -25,8 +25,8 @@ See full [documentation](yaml/README.md#jobs).
## Seeing pipeline status
You can find the current and historical pipeline runs under
**Pipelines**
for
your
project.
You can find the current and historical pipeline runs under
**Pipelines**
for
your
project.
## Seeing build status
...
...
@@ -36,42 +36,11 @@ cancel the build, retry it, or erase the build trace.
## Badges
Build status and test coverage report badges are available.
Go to pipeline settings to see available badges and code you can use to embed
badges in the
`README.md`
or on the website.
### Build status badge
You can access a build status badge image using the following link:
```
http://example.gitlab.com/namespace/project/badges/branch/build.svg
```
### Test coverage report badge
GitLab makes it possible to define the regular expression for coverage report,
that each build log will be matched against. This means that each build in the
pipeline can have the test coverage percentage value defined.
You can access the test coverage badge using following link:
```
http://example.gitlab.com/namespace/project/badges/branch/coverage.svg
```
If you would like to get the coverage report from the specific job, you can add
a
`job=coverage_job_name`
parameter to the URL. For example, it is possible to
use following Markdown code to embed the test coverage report into
`README.md`
:
```
markdown
![
coverage
](
http://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage
)
```
The latest successful pipeline will be used to read the test coverage value.
Build status and test coverage report badges are available. You can find their
respective link in the [Pipelines settings] page.
[
builds
]:
#builds
[
jobs
]:
yaml/README.md#jobs
[
stages
]:
yaml/README.md#stages
[
runners
]:
runners/README.md
[
runners
]:
runners/READM
[
pipelines settings
]:
../user/project/pipelines/settings.md
doc/user/project/img/project_settings_list.png
View replaced file @
fdd52a6b
View file @
4392098e
10.5 KB
|
W:
|
H:
11.1 KB
|
W:
|
H:
2-up
Swipe
Onion skin
doc/user/project/pipelines/img/pipelines_settings_badges.png
0 → 100644
View file @
4392098e
54.8 KB
doc/user/project/pipelines/settings.md
0 → 100644
View file @
4392098e
# CI/CD pipelines settings
To reach the pipelines settings:
1.
Navigate to your project and click the cog icon in the upper right corner.
![Project settings menu](../img/project_settings_list.png)
1.
Select
**CI/CD Pipelines**
from the menu.
The following settings can be configured per project.
## Git strategy
With Git strategy, you can choose the default way your repository is fetched
from GitLab in a job.
There are two options:
-
Using
`git clone`
which is slower since it clones the repository from scratch
for every job, ensuring that the project workspace is always pristine.
-
Using
`git fetch`
which is faster as it re-uses the project workspace (falling
back to clone if it doesn't exist).
The default Git strategy can be overridden by the
[
GIT_STRATEGY variable
][
var
]
in
`.gitlab-ci.yml`
.
## Timeout
Timeout defines the maximum amount of time in minutes that a job is able run.
The default value is 60 minutes. Decrease the time limit if you want to impose
a hard limit on your jobs' running time or increase it otherwise. In any case,
if the job surpasses the threshold, it is marked as failed.
## Test coverage parsing
If you use test coverage in your code, GitLab can capture its output in the
build trace using a regular expression. Leave blank if you want to disable it
or enter a ruby regular expression. You can use http://rubular.com to test your
regex.
A few examples can be found in the settings page.
## Visibility of pipelines
For public and internal projects, the
**Pipelines**
page can be accessed by
anyone and those logged in respectively. If you wish to hide it so that only
the members of the project or group have access to it, uncheck the
**
Public
pipelines
**
checkbox and save the changes.
## Badges
In the pipelines settings page you can find build status and test coverage
badges for your project. The latest successful pipeline will be used to read
the build status and test coverage values.
Visit the
**Pipelines**
settings page in your project to see the exact link to
your badges, as well as ways to embed the badge image in your HTML or Markdown
pages.
![
Pipelines badges
](
img/pipelines_settings_badges.png
)
### Build status badge
Depending on the status of your build, a badge can have the following values:
-
running
-
success
-
failed
-
skipped
-
unknown
You can access a build status badge image using the following link:
```
https://example.gitlab.com/<namespace>/<project>/badges/<branch>/build.svg
```
### Test coverage report badge
GitLab makes it possible to define the regular expression for [coverage report],
that each build log will be matched against. This means that each build in the
pipeline can have the test coverage percentage value defined.
The test coverage badge can be accessed using following link:
```
https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg
```
If you would like to get the coverage report from a specific job, you can add
the
`job=coverage_job_name`
parameter to the URL. For example, the following
Markdown code will embed the test coverage report badge of the
`coverage`
job
into your
`README.md`
:
```
markdown
![
coverage
](
https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg?job=coverage
)
```
[
var
]:
../../../ci/yaml/README.md#git-strategy
[
coverage report
]:
#test-coverage-parsing
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment