summaryrefslogtreecommitdiff
path: root/doc/ci/pipelines
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-02-16 12:08:03 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2023-02-16 12:08:03 +0000
commit12166c0faf75479889bc0ac432b85b9dae91552b (patch)
treefc5a3140e12c815beb6c34d44e2ad423a4f302ad /doc/ci/pipelines
parentb1a0a71628cb4531f3b9a2999f5aa4d22f6ac5fb (diff)
downloadgitlab-ce-12166c0faf75479889bc0ac432b85b9dae91552b.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/ci/pipelines')
-rw-r--r--doc/ci/pipelines/img/pipelines_settings_badges.pngbin21137 -> 0 bytes
-rw-r--r--doc/ci/pipelines/settings.md145
2 files changed, 2 insertions, 143 deletions
diff --git a/doc/ci/pipelines/img/pipelines_settings_badges.png b/doc/ci/pipelines/img/pipelines_settings_badges.png
deleted file mode 100644
index 3bdc6374c15..00000000000
--- a/doc/ci/pipelines/img/pipelines_settings_badges.png
+++ /dev/null
Binary files differ
diff --git a/doc/ci/pipelines/settings.md b/doc/ci/pipelines/settings.md
index cd696d816d7..3633863915c 100644
--- a/doc/ci/pipelines/settings.md
+++ b/doc/ci/pipelines/settings.md
@@ -311,149 +311,8 @@ 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.
-
-## Latest release badge
-
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33368) in GitLab 14.8.
-
-A latest release badge indicates the latest release tag name for your project.
-By default, the badge fetches the release sorted using the [`released_at`](../../api/releases/index.md#create-a-release) time.
-Support for [`semver`](https://semver.org/) sorting is tracked [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/352945).
-
-### View the code for the pipeline status, coverage reports, and latest release 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 **Main menu > Projects** and find your project.
-1. On the left sidebar, select **Settings > CI/CD**.
-1. Expand **General pipelines**.
-1. In the **Pipeline status**, **Coverage report**, or **Latest release** sections, view the URLs for the images.
-
-![Pipelines badges](img/pipelines_settings_badges.png)
-
-### Pipeline status badge
-
-Depending on the status of your pipeline, a badge can have the following values:
-
-- `pending`
-- `running`
-- `passed`
-- `failed`
-- `skipped`
-- `manual`
-- `canceled`
-- `unknown`
-
-You can access a pipeline status badge image by using the following link:
-
-```plaintext
-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:
-
-```plaintext
-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](#merge-request-test-coverage-results) 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:
-
-```plaintext
-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, you can use code
-similar to the following to add the test coverage report badge of the `coverage` job
-to a Markdown file:
-
-```markdown
-![coverage](https://gitlab.example.com/<namespace>/<project>/badges/<branch>/coverage.svg?job=coverage)
-```
-
-#### Test coverage report badge colors and limits
-
-The default colors and limits for the badge are as follows:
-
-- 95 up to and including 100% - good (`#4c1`)
-- 90 up to 95% - acceptable (`#a3c51c`)
-- 75 up to 90% - medium (`#dfb317`)
-- 0 up to 75% - low (`#e05d44`)
-- no coverage - unknown (`#9f9f9f`)
-
-NOTE:
-*Up to* means up to, but not including, the upper bound.
-
-You can overwrite the limits by using the following additional parameters ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/28317) in GitLab 14.4):
-
-- `min_good` (default 95, can use any value between 3 and 100)
-- `min_acceptable` (default 90, can use any value between 2 and min_good-1)
-- `min_medium` (default 75, can use any value between 1 and min_acceptable-1)
-
-If an invalid boundary is set, GitLab automatically adjusts it to be valid. For example,
-if `min_good` is set `80`, and `min_acceptable` is set to `85` (too high), GitLab automatically
-sets `min_acceptable` to `79` (`min_good` - `1`).
-
-### Latest release badge
-
-When a release exists in your project, it shows the latest release tag name. If there is no release,
-it shows `none`.
-
-You can access a latest release badge image by using the following link:
-
-```plaintext
-https://gitlab.example.com/<namespace>/<project>/-/badges/release.svg
-```
-
-#### Sorting preferences
-
-By default, the latest release badge fetches the release using `release_at` time. The use of the query parameter `?order_by=release_at` is optional, and support for `?order_by=semver` is tracked [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/352945):
-
-```plaintext
-https://gitlab.example.com/<namespace>/<project>/-/badges/release.svg?order_by=release_at
-```
-
-### 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):
-
- ```plaintext
- https://gitlab.example.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat
- ```
-
- ![Badge flat style](https://gitlab.com/gitlab-org/gitlab/badges/main/coverage.svg?job=coverage&style=flat)
-
-- Flat square ([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/30120) in GitLab 11.8):
-
- ```plaintext
- https://gitlab.example.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat-square
- ```
-
- ![Badge flat square style](https://gitlab.com/gitlab-org/gitlab/badges/main/coverage.svg?job=coverage&style=flat-square)
-
-### Custom badge text
-
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17555) 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:
-
-```plaintext
-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](https://gitlab.com/gitlab-org/gitlab/badges/main/coverage.svg?job=karma&key_text=Frontend+Coverage&key_width=130)
+You can use [pipeline badges](../../user/project/badges.md) to indicate the pipeline status and
+test coverage of your projects. These badges are determined by the latest successful pipeline.
<!-- ## Troubleshooting