Commit c88535ae authored by Mike Lewis's avatar Mike Lewis

Merge branch 'docs/refactor-pipelines-landing-page' into 'master'

Refactor and restructure pipelines landing page

Closes #58450

See merge request gitlab-org/gitlab-ce!26079
parents 11c8b5a1 6e4108b7
# Pipeline schedules # Pipeline schedules API
You can read more about [pipeline schedules](../user/project/pipelines/schedules.md). You can read more about [pipeline schedules](../user/project/pipelines/schedules.md).
...@@ -280,7 +280,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gi ...@@ -280,7 +280,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gi
## Pipeline schedule variable ## Pipeline schedule variable
> [Introduced][ce-34518] in GitLab 10.0. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/34518) in GitLab 10.0.
## Create a new pipeline schedule variable ## Create a new pipeline schedule variable
...@@ -358,5 +358,3 @@ curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gi ...@@ -358,5 +358,3 @@ curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gi
"value": "updated value" "value": "updated value"
} }
``` ```
[ce-34518]: https://gitlab.com/gitlab-org/gitlab-ce/issues/34518
\ No newline at end of file
...@@ -45,7 +45,7 @@ into more features: ...@@ -45,7 +45,7 @@ into more features:
| Topic | Description | | Topic | Description |
|:--------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------| |:--------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| [Introduction to pipelines and jobs](pipelines.md) | Provides an overview of GitLab CI/CD and jobs. | | [Creating and using CI/CD pipelines](pipelines.md) | Understand, visualize, create, and use CI/CD pipelines. |
| [CI/CD Variables](variables/README.md) | How environment variables can be configured and made available in pipelines. | | [CI/CD Variables](variables/README.md) | How environment variables can be configured and made available in pipelines. |
| [Where variables can be used](variables/where_variables_can_be_used.md) | A deeper look into where and how CI/CD variables can be used. | | [Where variables can be used](variables/where_variables_can_be_used.md) | A deeper look into where and how CI/CD variables can be used. |
| [User](../user/permissions.md#gitlab-cicd-permissions) and [job](../user/permissions.md#job-permissions) permissions | Learn about the access levels a user can have for performing certain CI actions. | | [User](../user/permissions.md#gitlab-cicd-permissions) and [job](../user/permissions.md#job-permissions) permissions | Learn about the access levels a user can have for performing certain CI actions. |
......
...@@ -9,13 +9,18 @@ For example, unit tests, lint checks, and [Review Apps](../review_apps/index.md) ...@@ -9,13 +9,18 @@ For example, unit tests, lint checks, and [Review Apps](../review_apps/index.md)
are often used in this cycle. are often used in this cycle.
With pipelines for merge requests, you can design a specific pipeline structure With pipelines for merge requests, you can design a specific pipeline structure
for merge requests. All you need to do is just adding `only: [merge_requests]` to for merge requests.
the jobs that you want it to run for only merge requests.
Every time, when developers create or update merge requests, a pipeline runs on ## Configuring pipelines for merge requests
To configure pipelines for merge request, add the `only: merge_requests` parameter to
the jobs that you want it to run only for merge requests.
Then, when developers create or update merge requests, a pipeline runs on
their new commits at every push to GitLab. their new commits at every push to GitLab.
NOTE: **Note**: NOTE: **Note**:
If you use both this feature and [Merge When Pipeline Succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md), If you use this feature with [merge when pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md),
pipelines for merge requests take precedence over the other regular pipelines. pipelines for merge requests take precedence over the other regular pipelines.
For example, consider the following [`.gitlab-ci.yml`](../yaml/README.md): For example, consider the following [`.gitlab-ci.yml`](../yaml/README.md):
...@@ -40,15 +45,17 @@ deploy: ...@@ -40,15 +45,17 @@ deploy:
script: ./deploy script: ./deploy
``` ```
After the merge request is updated with new commits, GitLab detects that changes After the merge request is updated with new commits:
have occurred and creates a new pipeline for the merge request.
The pipeline fetches the latest code from the source branch and run tests against it. - GitLab detects that changes have occurred and creates a new pipeline for the merge request.
- The pipeline fetches the latest code from the source branch and run tests against it.
In the above example, the pipeline contains only `build` and `test` jobs. In the above example, the pipeline contains only `build` and `test` jobs.
Since the `deploy` job doesn't have the `only: [merge_requests]` rule, Since the `deploy` job doesn't have the `only: merge_requests` rule,
deployment jobs will not happen in the merge request. deployment jobs will not happen in the merge request.
Pipelines tagged as **merge request** indicate that they were triggered Pipelines tagged with **merge request** badge indicate that they were triggered
when a merge request was created or updated. when a merge request was created or updated. For example:
![Merge request page](img/merge_request.png) ![Merge request page](img/merge_request.png)
...@@ -62,9 +69,14 @@ The behavior of the `only: merge_requests` rule is such that _only_ jobs with ...@@ -62,9 +69,14 @@ The behavior of the `only: merge_requests` rule is such that _only_ jobs with
that rule are run in the context of a merge request; no other jobs will be run. that rule are run in the context of a merge request; no other jobs will be run.
However, you may want to reverse this behaviour, having all of your jobs to run _except_ However, you may want to reverse this behaviour, having all of your jobs to run _except_
for one or two. Consider the following pipeline, with jobs `A`, `B`, and `C`. If you want for one or two.
all pipelines to always run `A` and `B`, but only want `C` to run for a merge request,
you can configure your `.gitlab-ci.yml` file as follows: Consider the following pipeline, with jobs `A`, `B`, and `C`. Imagine you want:
- All pipelines to always run `A` and `B`
- Only want `C` to run for a merge request,
To achieve this, you can configure your `.gitlab-ci.yml` file as follows:
``` yaml ``` yaml
.only-default: &only-default .only-default: &only-default
...@@ -90,9 +102,11 @@ C: ...@@ -90,9 +102,11 @@ C:
- merge_requests - merge_requests
``` ```
Since `A` and `B` are getting the `only:` rule to execute in all cases, they will Because:
always run. `C` specifies that it should only run for merge requests, so for any
pipeline except a merge request pipeline, it will not run. - `A` and `B` are getting the `only:` rule to execute in all cases, they will always run.
- `C` specifies that it should only run for merge requests, it will not run for any pipeline
except a merge request pipeline.
As you can see, this will help you avoid a lot of boilerplate where you'd need As you can see, this will help you avoid a lot of boilerplate where you'd need
to add that `only:` rule to all of your jobs in order to make them always run. You to add that `only:` rule to all of your jobs in order to make them always run. You
......
This diff is collapsed.
# Merge When Pipeline Succeeds # Merge when pipeline succeeds
When reviewing a merge request that looks ready to merge but still has one or When reviewing a merge request that looks ready to merge but still has one or
more CI jobs running, you can set it to be merged automatically when the more CI jobs running, you can set it to be merged automatically when the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment