Customize pipeline configuration

You can customize how pipelines run for your project.

For an overview of pipelines, watch the video GitLab CI Pipeline, Artifacts, and Environments. Watch also GitLab CI pipeline tutorial for beginners.

Change which users can view your pipelines

For public and internal projects, you can change who can see your:

However:

To change the visibility of your pipelines and related features:

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General pipelines.
  4. Select or clear the Public pipelines checkbox. When it is selected, pipelines and related features are visible:

    • For public projects, to everyone.
    • For internal projects, to all logged-in users except external users.
    • For private projects, to all project members (Guest or higher).

    When it is cleared:

    • For public projects, pipelines are visible to everyone. Related features are visible only to project members (Reporter or higher).
    • For internal projects, pipelines are visible to all logged in users except external users. Related features are visible only to project members (Reporter or higher).
    • For private projects, pipelines and related features are visible to project members (Reporter or higher) only.

Auto-cancel redundant pipelines

You can set pending or running pipelines to cancel automatically when a new pipeline runs on the same branch. You can enable this in the project settings:

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General Pipelines.
  4. Select the Auto-cancel redundant pipelines checkbox.
  5. Select Save changes.

Use the interruptible keyword to indicate if a running job can be cancelled before it completes.

Skip outdated deployment jobs

Introduced in GitLab 12.9.

Your project may have multiple concurrent deployment jobs that are scheduled to run in the same time frame.

This can lead to a situation where an older deployment job runs after a newer one, which may not be what you want.

To avoid this scenario:

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General pipelines.
  4. Select the Skip outdated deployment jobs checkbox.
  5. Select Save changes.

Older deployment job are skipped when a new deployment starts.

For more information, see Deployment safety.

Retry outdated jobs

Introduced in GitLab 13.6.

A deployment job can fail because a newer one has run. If you retry the failed deployment job, the environment could be overwritten with older source code. If you click Retry, a modal warns you about this and asks for confirmation.

For more information, see Deployment safety.

Specify a custom CI/CD configuration file

GitLab expects to find the CI/CD configuration file (.gitlab-ci.yml) in the project’s root directory. However, you can specify an alternate filename path, including locations outside the project.

To customize the path:

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General pipelines.
  4. In the CI/CD configuration file field, enter the filename. If the file:
    • Is not in the root directory, include the path.
    • Is in a different project, include the group and project name.
    • Is on an external site, enter the full URL.
  5. Select Save changes.

Custom CI/CD configuration file examples

If the CI/CD configuration file is not in the root directory, the path must be relative to it. For example:

  • my/path/.gitlab-ci.yml
  • my/path/.my-custom-file.yml

If the CI/CD configuration file is on an external site, the URL must end with .yml:

  • http://example.com/generate/ci/config.yml

If the CI/CD configuration file is in a different project:

  • The file must exist on its default branch, or specify the branch as refname.
  • The path must be relative to the root directory in the other project.
  • The path must include the group and project name at the end.

For example:

  • .gitlab-ci.yml@mygroup/another-project
  • my/path/.my-custom-file.yml@mygroup/another-project
  • my/path/.my-custom-file.yml@mygroup/another-project:refname

If the configuration file is in a separate project, you can more set more granular permissions. For example:

  • Create a public project to host the configuration file.
  • Give write permissions on the project only to users who are allowed to edit the file.

Then other users and projects can access the configuration file without being able to edit it.

Choose the default Git strategy

You can choose how your repository is fetched from GitLab when a job runs.

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General pipelines.
  4. Under Git strategy, select an option:
    • git clone is slower because it clones the repository from scratch for every job. However, the local working copy is always pristine.
    • git fetch is faster because it re-uses the local working copy (and falls back to clone if it doesn’t exist). This is recommended, especially for large repositories.

The configured Git strategy can be overridden by the GIT_STRATEGY variable in the .gitlab-ci.yml file.

Limit the number of changes fetched during clone

Introduced in GitLab 12.0.

You can limit the number of changes that GitLab CI/CD fetches when it clones a repository.

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General pipelines.
  4. Under Git strategy, under Git shallow clone, enter a value. The maximum value is 1000. To disable shallow clone and make GitLab CI/CD fetch all branches and tags each time, keep the value empty or set to 0.

In GitLab 12.0 and later, newly created projects automatically have a default git depth value of 50.

This value can be overridden by the GIT_DEPTH variable in the .gitlab-ci.yml file.

Set a limit for how long jobs can run

You can define how long a job can run before it times out.

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General pipelines.
  4. In the Timeout field, enter the number of minutes, or a human-readable value like 2 hours.

Jobs that exceed the timeout are marked as failed.

You can override this value for individual runners.

Add test coverage results to a merge request

If you use test coverage in your code, you can use a regular expression to find coverage results in the job log. You can then include these results in the merge request in GitLab.

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General pipelines.
  4. In the Test coverage parsing field, enter a regular expression. Leave blank to disable this feature.

You can use https://rubular.com to test your regex. The regex returns the last match found in the output.

If the pipeline succeeds, the coverage is shown in the merge request widget and in the jobs table. If multiple jobs in the pipeline have coverage reports, they are averaged.

MR widget coverage

Build status coverage

Test coverage examples

Use this regex for commonly used test tools.

  • Simplecov (Ruby). Example: \(\d+.\d+\%\) covered.
  • pytest-cov (Python). Example: ^TOTAL.+?(\d+\%)$.
  • Scoverage (Scala). Example: Statement coverage[A-Za-z\.*]\s*:\s*([^%]+).
  • phpunit --coverage-text --colors=never (PHP). Example: ^\s*Lines:\s*\d+.\d+\%.
  • gcovr (C/C++). Example: ^TOTAL.*\s+(\d+\%)$.
  • tap --coverage-report=text-summary (NodeJS). Example: ^Statements\s*:\s*([^%]+).
  • nyc npm test (NodeJS). Example: All files[^|]*\|[^|]*\s+([\d\.]+).
  • excoveralls (Elixir). Example: \[TOTAL\]\s+(\d+\.\d+)%.
  • mix test --cover (Elixir). Example: \d+.\d+\%\s+\|\s+Total.
  • JaCoCo (Java/Kotlin). Example: Total.*?([0-9]{1,3})%.
  • go test -cover (Go). Example: coverage: \d+.\d+% of statements.
  • .NET (OpenCover). Example: (Visited Points).*\((.*)\).
  • .NET (dotnet test line coverage). Example: Total\s*\|\s*(\d+(?:\.\d+)?).
  • tarpaulin (Rust). Example: ^\d+.\d+% coverage.

View code coverage history

Version history

To see the evolution of your project code coverage over time, you can view a graph or download a CSV file with this data.

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Analytics > Repository.

The historic data for each job is listed in the dropdown above the graph.

To view a CSV file of the data, select Download raw data (.csv).

Code coverage graph of a project over time

Code coverage data is also available at the group level.

Coverage check approval rule

Version history

You can implement merge request approvals to require approval by selected users or a group when merging a merge request would cause the project’s test coverage to decline.

Follow these steps to enable the Coverage-Check MR approval rule:

  1. Set up a coverage: regular expression for all jobs you want to include in the overall coverage value.
  2. Go to your project and select Settings > General.
  3. Expand Merge request approvals.
  4. Select Enable next to the Coverage-Check approval rule.
  5. Select the Target branch.
  6. Set the number of Approvals required to greater than zero.
  7. Select the users or groups to provide approval.
  8. Select Add approval rule.

Coverage-Check approval rule

Remove color codes from code coverage

Some test coverage tools output with ANSI color codes that aren’t parsed correctly by the regular expression. This causes coverage parsing to fail.

Some coverage tools don’t provide an option to disable color codes in the output. If so, pipe the output of the coverage tool through a small one line script that strips the color codes off.

For example:

lein cloverage | perl -pe 's/\e\[?.*?[\@-~]//g'

Pipeline badges

Pipeline badges indicate the pipeline status and a test coverage value for your project. These badges are determined by the latest successful pipeline.

View the code for the pipeline status and coverage reports badges

You can view the exact link for your badges. Then you can embed the badge in your HTML or Markdown pages.

  1. On the top bar, select Menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand General pipelines.
  4. In the Pipeline status or Coverage report sections, view the URLs for the images.

Pipelines badges

Pipeline status badge

Depending on the status of your pipeline, a badge can have the following values:

  • pending
  • running
  • passed
  • failed
  • skipped
  • canceled
  • unknown

You can access a pipeline status badge image by using the following link:

https://gitlab.example.com/<namespace>/<project>/badges/<branch>/pipeline.svg

Display only non-skipped status

To make the pipeline status badge display only the last non-skipped status, use the ?ignore_skipped=true query parameter:

https://gitlab.example.com/<namespace>/<project>/badges/<branch>/pipeline.svg?ignore_skipped=true

Test coverage report badge

You can define the regular expression for the coverage report that each job log is matched against. This means that each job in the pipeline can have the test coverage percentage value defined.

To access the test coverage badge, use the following link:

https://gitlab.example.com/<namespace>/<project>/badges/<branch>/coverage.svg

To get the coverage report from a specific job, add the job=coverage_job_name parameter to the URL. For example, the following Markdown code embeds the test coverage report badge of the coverage job in your README.md:

![coverage](https://gitlab.com/gitlab-org/gitlab/badges/main/coverage.svg?job=coverage)

Badge styles

Pipeline badges can be rendered in different styles by adding the style=style_name parameter to the URL. Two styles are available:

  • Flat (default):

    https://gitlab.example.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat
    

    Badge flat style

  • Flat square (Introduced in GitLab 11.8):

    https://gitlab.example.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat-square
    

    Badge flat square style

Custom badge text

Introduced in GitLab 13.1.

The text for a badge can be customized to differentiate between multiple coverage jobs that run in the same pipeline. Customize the badge text and width by adding the key_text=custom_text and key_width=custom_key_width parameters to the URL:

https://gitlab.com/gitlab-org/gitlab/badges/main/coverage.svg?job=karma&key_text=Frontend+Coverage&key_width=130

Badge with custom text and width