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
1
Merge Requests
1
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
nexedi
gitlab-ce
Commits
272386cf
Commit
272386cf
authored
Jul 28, 2020
by
Albert Salim
Committed by
Evan Read
Jul 28, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clarify pipeline documentation
- prioritise workflow rules in the page - add summary of MR pipeline types
parent
ff861e9b
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
31 additions
and
19 deletions
+31
-19
doc/development/pipelines.md
doc/development/pipelines.md
+31
-19
No files found.
doc/development/pipelines.md
View file @
272386cf
...
@@ -13,10 +13,38 @@ as much as possible.
...
@@ -13,10 +13,38 @@ as much as possible.
## Overview
## Overview
### Pipeline types
Pipelines for the GitLab project are created using the
[
`workflow:rules` keyword
](
../ci/yaml/README.md#workflowrules
)
feature of the GitLab CI/CD.
Since we use the
[
`rules:`
](
../ci/yaml/README.md#rules
)
and
[
`needs:`
](
../ci/yaml/README.md#needs
)
keywords extensively,
Pipelines are always created for the following scenarios:
we have four main pipeline types which are described below. Note that an MR that includes multiple types of changes would
-
`master`
branch, including on schedules, pushes, merges, and so on.
-
Merge requests.
-
Tags.
-
Stable,
`auto-deploy`
, and security branches.
Pipeline creation is also affected by the following CI variables:
-
If
`$FORCE_GITLAB_CI`
is set, pipelines are created.
-
If
`$GITLAB_INTERNAL`
is not set, pipelines are not created.
No pipeline is created in any other cases (for example, when pushing a branch with no
MR for it).
The source of truth for these workflow rules is defined in
<https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab-ci.yml>
.
### Pipelines for Merge Requests
In general, pipelines for an MR fall into one or more of the following types,
depending on the changes made in the MR:
-
[
Docs-only MR pipeline
](
#docs-only-mr-pipeline
)
: This is typically created for an MR that only changes documentation.
-
[
Code-only MR pipeline
](
#code-only-mr-pipeline
)
: This is typically created for an MR that only changes code, either backend or frontend.
-
[
Frontend-only MR pipeline
](
#frontend-only-mr-pipeline
)
: This is typically created for an MR that only changes frontend code.
-
[
QA-only MR pipeline
](
#qa-only-mr-pipeline
)
: This is typically created for an MR that only changes end to end tests related code.
We use the
[
`rules:`
](
../ci/yaml/README.md#rules
)
and
[
`needs:`
](
../ci/yaml/README.md#needs
)
keywords extensively
to determine the jobs that need to be run in a pipeline. Note that an MR that includes multiple types of changes would
have a pipelines that include jobs from multiple types (e.g. a combination of docs-only and code-only pipelines).
have a pipelines that include jobs from multiple types (e.g. a combination of docs-only and code-only pipelines).
#### Docs-only MR pipeline
#### Docs-only MR pipeline
...
@@ -345,22 +373,6 @@ graph RL;
...
@@ -345,22 +373,6 @@ graph RL;
end
end
```
```
### `workflow:rules`
We're using the
[
`workflow:rules` keyword
](
../ci/yaml/README.md#workflowrules
)
to
define default rules to determine whether or not a pipeline is created.
These rules are defined in
<https://gitlab.com/gitlab-org/gitlab/blob/master/.gitlab-ci.yml>
and are as follows:
1.
If
`$FORCE_GITLAB_CI`
is set, create a pipeline.
1.
For merge requests, create a pipeline.
1.
For
`master`
branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
1.
For tags, create a pipeline.
1.
If
`$GITLAB_INTERNAL`
isn't set, don't create a pipeline.
1.
For stable, auto-deploy, and security branches, create a pipeline.
1.
For any other cases (e.g. when pushing a branch with no MR for it), no pipeline is created.
### PostgreSQL versions testing
### PostgreSQL versions testing
#### Current versions testing
#### Current versions testing
...
...
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