diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-13 18:09:21 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-13 18:09:21 +0300 |
commit | c36152ff8c41fad2f413f253eb7ac5c927e47c56 (patch) | |
tree | bbf300da207de3e8bbf272d44111ceedb18f5833 /doc/user/project/pipelines | |
parent | 286fe61013674fe2d245ffc8d2233baf09923e70 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/project/pipelines')
-rw-r--r-- | doc/user/project/pipelines/img/pipelines_settings_badges.png | bin | 21137 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/pipelines/img/pipelines_settings_test_coverage.png | bin | 2549 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/pipelines/img/pipelines_test_coverage_build.png | bin | 4481 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/pipelines/img/pipelines_test_coverage_mr_widget.png | bin | 6375 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/pipelines/job_artifacts.md | 2 | ||||
-rw-r--r-- | doc/user/project/pipelines/settings.md | 307 |
6 files changed, 3 insertions, 306 deletions
diff --git a/doc/user/project/pipelines/img/pipelines_settings_badges.png b/doc/user/project/pipelines/img/pipelines_settings_badges.png Binary files differdeleted file mode 100644 index 3bdc6374c15..00000000000 --- a/doc/user/project/pipelines/img/pipelines_settings_badges.png +++ /dev/null diff --git a/doc/user/project/pipelines/img/pipelines_settings_test_coverage.png b/doc/user/project/pipelines/img/pipelines_settings_test_coverage.png Binary files differdeleted file mode 100644 index 13ed69be810..00000000000 --- a/doc/user/project/pipelines/img/pipelines_settings_test_coverage.png +++ /dev/null diff --git a/doc/user/project/pipelines/img/pipelines_test_coverage_build.png b/doc/user/project/pipelines/img/pipelines_test_coverage_build.png Binary files differdeleted file mode 100644 index 7eaba1a256f..00000000000 --- a/doc/user/project/pipelines/img/pipelines_test_coverage_build.png +++ /dev/null diff --git a/doc/user/project/pipelines/img/pipelines_test_coverage_mr_widget.png b/doc/user/project/pipelines/img/pipelines_test_coverage_mr_widget.png Binary files differdeleted file mode 100644 index fbcd612f3f2..00000000000 --- a/doc/user/project/pipelines/img/pipelines_test_coverage_mr_widget.png +++ /dev/null diff --git a/doc/user/project/pipelines/job_artifacts.md b/doc/user/project/pipelines/job_artifacts.md index 5892a1be494..c23eaebcbe9 100644 --- a/doc/user/project/pipelines/job_artifacts.md +++ b/doc/user/project/pipelines/job_artifacts.md @@ -2,4 +2,4 @@ redirect_to: '../../../ci/pipelines/job_artifacts.md' --- -This document was moved to [pipelines/job_artifacts.md](../../../ci/pipelines/job_artifacts.md). +This document was moved to [another location](../../../ci/pipelines/job_artifacts.md). diff --git a/doc/user/project/pipelines/settings.md b/doc/user/project/pipelines/settings.md index f67f0896de4..af4cbe13aba 100644 --- a/doc/user/project/pipelines/settings.md +++ b/doc/user/project/pipelines/settings.md @@ -1,308 +1,5 @@ --- -type: reference, howto +redirect_to: '../../../ci/pipelines/settings.md' --- -# Pipelines settings - -To reach the pipelines settings navigate to your project's -**Settings > CI/CD**. - -The following settings can be configured per project. - -<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> -For an overview, watch the video [GitLab CI Pipeline, Artifacts, and Environments](https://www.youtube.com/watch?v=PCKDICEe10s). -Watch also [GitLab CI pipeline tutorial for beginners](https://www.youtube.com/watch?v=Jav4vbUrqII). - -## 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 local working copy is always pristine. -- `git fetch`, which is faster as it re-uses the local working copy (falling - back to clone if it doesn't exist). - -The default Git strategy can be overridden by the [GIT_STRATEGY variable](../../../ci/yaml/README.md#git-strategy) -in `.gitlab-ci.yml`. - -## Git shallow clone - -> [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 -`git depth` value of `50`. - -It is possible to limit the number of changes that GitLab CI/CD will fetch when cloning -a repository. Setting a limit to `git depth` can speed up Pipelines execution. Maximum -allowed 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`. - -This value can also be [overridden by `GIT_DEPTH`](../../../ci/large_repositories/index.md#shallow-cloning) variable in `.gitlab-ci.yml` file. - -## Timeout - -Timeout defines the maximum amount of time in minutes that a job is able run. -This is configurable under your project's **Settings > CI/CD > General pipelines settings**. -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. - -### Timeout overriding on Runner level - -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17221) in GitLab 10.7. - -Project defined timeout (either specific timeout set by user or the default -60 minutes timeout) may be [overridden on Runner level](../../../ci/runners/README.md#setting-maximum-job-timeout-for-a-runner). - -## Maximum artifacts size **(CORE ONLY)** - -For information about setting a maximum artifact size for a project, see -[Maximum artifacts size](../../admin_area/settings/continuous_integration.md#maximum-artifacts-size-core-only). - -## Custom CI configuration path - -> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12509) in GitLab 9.4. -> - [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. - -To customize the path: - -1. Go to the project's **Settings > CI / CD**. -1. Expand the **General pipelines** section. -1. Provide a value in the **Custom CI configuration path** field. -1. Click **Save changes**. - -If the CI configuration is stored within the repository in a non-default -location, the path must be relative to the root directory. Examples of valid -paths and file names include: - -- `.gitlab-ci.yml` (default) -- `.my-custom-file.yml` -- `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`: - -- `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: - -- `.gitlab-ci.yml@mygroup/another-project` -- `my/path/.my-custom-file.yml@mygroup/another-project` - -Hosting the configuration file in a separate project allows stricter control of the -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 -able to edit it. - -## Test coverage parsing - -If you use test coverage in your code, GitLab can capture its output in the -job log using a regular expression. In the pipelines settings, search for the -"Test coverage parsing" section. - -![Pipelines settings test coverage](img/pipelines_settings_test_coverage.png) - -Leave blank if you want to disable it or enter a ruby regular expression. You -can use <https://rubular.com> to test your regex. - -If the pipeline succeeds, the coverage is shown in the merge request widget and -in the jobs table. - -![MR widget coverage](img/pipelines_test_coverage_mr_widget.png) - -![Build status coverage](img/pipelines_test_coverage_build.png) - -A few examples of known coverage tools for a variety of languages can be found -in the pipelines settings page. - -### 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 -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. - -For example: - -```shell -lein cloverage | perl -pe 's/\e\[?.*?[\@-~]//g' -``` - -## Visibility of pipelines - -Pipeline visibility is determined by: - -- Your current [user access level](../../permissions.md). -- 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](../../../ci/enable_or_disable_ci.md#per-project-user-setting). - -This also determines the visibility of these related features: - -- Job output logs -- Job artifacts -- The [pipeline security dashboard](../../application_security/security_dashboard/index.md#pipeline-security-dashboard) **(ULTIMATE)** - -If **Public pipelines** is enabled (default): - -- For **public** projects, anyone can view the pipelines and related features. -- For **internal** projects, any logged in user can view the pipelines - and related features. -- For **private** projects, any project member (guest or higher) can view the pipelines - and related features. - -If **Public pipelines** is disabled: - -- For **public** projects, anyone can view the pipelines, but only members - (reporter or higher) can access the related features. -- For **internal** projects, any logged in user can view the pipelines. - However, only members (reporter or higher) can access the job related features. -- For **private** projects, only project members (reporter or higher) - can view the pipelines or access the related features. - -## Auto-cancel pending pipelines - -> [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: - -1. Go to **{settings}** **Settings > CI / CD**. -1. Expand **General Pipelines**. -1. Check the **Auto-cancel redundant, pending pipelines** checkbox. -1. Click **Save changes**. - -## Skip older, pending deployment jobs - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/25276) in GitLab 12.9. - -Your project may have multiple concurrent deployment jobs that are -scheduled to run within 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. Go to **{settings}** **Settings > CI / CD**. -1. Expand **General pipelines**. -1. Check the **Skip older, pending deployment jobs** checkbox. -1. Click **Save changes**. - -The pending deployment jobs will be skipped. - -## 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 -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 -pages. - -![Pipelines badges](img/pipelines_settings_badges.png) - -### Pipeline status badge - -Depending on the status of your job, a badge can have the following values: - -- pending -- running -- passed -- failed -- skipped -- canceled -- unknown - -You can access a pipeline status badge image using the following link: - -```text -https://example.gitlab.com/<namespace>/<project>/badges/<branch>/pipeline.svg -``` - -### 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 -pipeline can have the test coverage percentage value defined. - -The test coverage badge can be accessed using following link: - -```text -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-foss/badges/master/coverage.svg?job=coverage) -``` - -### 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: - -#### Flat (default) - -```text -https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat -``` - -![Badge flat style](https://gitlab.com/gitlab-org/gitlab-foss/badges/master/coverage.svg?job=coverage&style=flat) - -#### Flat square - -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/30120) in GitLab 11.8. - -```text -https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat-square -``` - -![Badge flat square style](https://gitlab.com/gitlab-org/gitlab-foss/badges/master/coverage.svg?job=coverage&style=flat-square) - -## Environment Variables - -[Environment variables](../../../ci/variables/README.md#gitlab-cicd-environment-variables) can be set in an environment to be available to a runner. - -## Deploy Keys - -With Deploy Keys, GitLab allows you to import SSH public keys. You can then have -read only or read/write access to your project from the machines the keys were generated from. - -SSH keys added to your project settings will be used for continuous integration, -staging, or production servers. - -<!-- ## Troubleshooting - -Include any troubleshooting steps that you can foresee. If you know beforehand what issues -one might have when setting this up, or when something is changed, or on upgrading, it's -important to describe those, too. Think of things that may go wrong and include them here. -This is important to minimize requests for support, and to avoid doc comments with -questions that you know someone might ask. - -Each scenario can be a third-level heading, e.g. `### Getting error message X`. -If you have none to add when creating a doc, leave this section in place -but commented out to help encourage others to add to it in the future. --> +This document was moved to [another location](../../../ci/pipelines/settings.md). |