diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-10-05 16:54:15 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-10-05 16:54:15 +0300 |
commit | be834a25982746ffd85252ff502df42bb88cb9d5 (patch) | |
tree | b4d6a8ba0931e12fac08f05abea33a3b8ec2c8a2 /doc/ci/pipelines/settings.md | |
parent | ee925a3597f27e92f83a50937a64068109675b3d (diff) |
Add latest changes from gitlab-org/gitlab@13-5-stable-eev13.5.0-rc32
Diffstat (limited to 'doc/ci/pipelines/settings.md')
-rw-r--r-- | doc/ci/pipelines/settings.md | 52 |
1 files changed, 25 insertions, 27 deletions
diff --git a/doc/ci/pipelines/settings.md b/doc/ci/pipelines/settings.md index 849eb66d07f..4dcdf469e5c 100644 --- a/doc/ci/pipelines/settings.md +++ b/doc/ci/pipelines/settings.md @@ -37,10 +37,10 @@ in `.gitlab-ci.yml`. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/28919) in GitLab 12.0. NOTE: **Note:** -As of GitLab 12.0, newly created projects will automatically have a default +As of GitLab 12.0, newly created projects automatically have a default `git depth` value of `50`. -It is possible to limit the number of changes that GitLab CI/CD will fetch when cloning +It is possible to limit the number of changes that GitLab CI/CD fetches when cloning a repository. Setting a limit to `git depth` can speed up Pipelines execution. Maximum allowed value is `1000`. @@ -75,7 +75,7 @@ For information about setting a maximum artifact size for a project, see > - [Support for external `.gitlab-ci.yml` locations](https://gitlab.com/gitlab-org/gitlab/-/issues/14376) introduced in GitLab 12.6. By default we look for the `.gitlab-ci.yml` file in the project's root -directory. If needed, you can specify an alternate path and file name, including locations outside the project. +directory. If needed, you can specify an alternate path and filename, including locations outside the project. To customize the path: @@ -93,12 +93,12 @@ paths and file names include: - `my/path/.gitlab-ci.yml` - `my/path/.my-custom-file.yml` -If the CI configuration will be hosted on an external site, the URL link must end with `.yml`: +If hosting the CI configuration on an external site, the URL link must end with `.yml`: - `http://example.com/generate/ci/config.yml` -If the CI configuration will be hosted in a different project within GitLab, the path must be relative -to the root directory in the other project, with the group and project name added to the end: +If hosting the CI configuration in a different project within GitLab, the path must be relative +to the root directory in the other project. Include the group and project name at the end: - `.gitlab-ci.yml@mygroup/another-project` - `my/path/.my-custom-file.yml@mygroup/another-project` @@ -109,7 +109,7 @@ configuration file. 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. -Other users and projects will be able to access the configuration file without being +Other users and projects can access the configuration file without being able to edit it. ## Test coverage parsing @@ -125,8 +125,8 @@ 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 will -be averaged. +in the jobs table. If multiple jobs in the pipeline have coverage reports, they are +averaged. ![MR widget coverage](img/pipelines_test_coverage_mr_widget.png) @@ -140,7 +140,7 @@ in the pipelines settings page. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/209121) the ability to download a `.csv` in GitLab 12.10. > - [Graph introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33743) in GitLab 13.1. -If you want to see the evolution of your project code coverage over time, +To see the evolution of your project code coverage over time, you can view a graph or download a CSV file with this data. From your project: 1. Go to **{chart}** **Project Analytics > Repository** to see the historic data for each job listed in the dropdown above the graph. @@ -150,13 +150,13 @@ you can view a graph or download a CSV file with this data. From your project: ### Removing color codes -Some test coverage tools output with ANSI color codes that won't be -parsed correctly by the regular expression and will cause 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. -If your coverage tool doesn't provide an option to disable color -codes in the output, you can pipe the output of the coverage tool through a -small one line script that will strip the color codes off. +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: @@ -172,7 +172,7 @@ Pipeline visibility is determined by: - The **Public pipelines** project setting under your project's **Settings > CI/CD > General pipelines**. NOTE: **Note:** -If the project visibility is set to **Private**, the [**Public pipelines** setting will have no effect](../enable_or_disable_ci.md#per-project-user-setting). +If the project visibility is set to **Private**, the [**Public pipelines** setting has no effect](../enable_or_disable_ci.md#per-project-user-setting). This also determines the visibility of these related features: @@ -204,16 +204,14 @@ If **Public pipelines** is disabled: > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9362) in GitLab 9.1. -If you want all pending non-HEAD pipelines on branches to auto-cancel each time -a new pipeline is created, such as after a Git push or manually from the UI, -you can enable this in the project settings: +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. Go to **Settings > CI / CD**. 1. Expand **General Pipelines**. 1. Check the **Auto-cancel redundant, pending pipelines** checkbox. 1. Click **Save changes**. -Note that only jobs with [interruptible](../yaml/README.md#interruptible) set to `true` will be cancelled. +Note that only jobs with [interruptible](../yaml/README.md#interruptible) set to `true` are cancelled. ## Skip outdated deployment jobs @@ -232,18 +230,18 @@ To avoid this scenario: 1. Check the **Skip outdated deployment jobs** checkbox. 1. Click **Save changes**. -The pending deployment jobs will be skipped. +When enabled, any older deployments job are skipped when a new deployment starts. For more information, see [Deployment safety](../environments/deployment_safety.md). ## Pipeline Badges In the pipelines settings page you can find pipeline status and test coverage -badges for your project. The latest successful pipeline will be used to read +badges for your project. The latest successful pipeline is used to read the pipeline 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 +your badges. You can also see ways to embed the badge image in your HTML or Markdown pages. ![Pipelines badges](img/pipelines_settings_badges.png) @@ -276,8 +274,8 @@ https://gitlab.example.com/<namespace>/<project>/badges/<branch>/pipeline.svg?ig ### Test coverage report badge -GitLab makes it possible to define the regular expression for [coverage report](#test-coverage-parsing), -that each job log will be matched against. This means that each job in the +GitLab makes it possible to define the regular expression for the [coverage report](#test-coverage-parsing), +that each job log is matched against. This means that each job in the pipeline can have the test coverage percentage value defined. The test coverage badge can be accessed using following link: @@ -288,7 +286,7 @@ https://gitlab.example.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 +Markdown code embeds the test coverage report badge of the `coverage` job into your `README.md`: ```markdown @@ -297,7 +295,7 @@ into your `README.md`: ### Badge styles -Pipeline badges can be rendered in different styles by adding the `style=style_name` parameter to the URL. Currently two styles are available: +Pipeline badges can be rendered in different styles by adding the `style=style_name` parameter to the URL. Two styles are available: #### Flat (default) |