Commit e2ebb32b authored by Marcel Amirault's avatar Marcel Amirault

Merge branch 'rw/fix-test-coverage-visualization-badges-docs' into 'master'

Fixing docs badges for inline code coverage

See merge request gitlab-org/gitlab!42546
parents de012a25 e4b53c58
...@@ -5,13 +5,13 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -5,13 +5,13 @@ info: To determine the technical writer assigned to the Stage/Group associated w
type: reference, howto type: reference, howto
--- ---
# Test Coverage Visualization **(CORE ONLY)** # Test Coverage Visualization
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3708) in GitLab 12.9. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3708) in GitLab 12.9.
> - [Feature flag enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/211410) in GitLab 13.4. > - [Feature flag enabled](https://gitlab.com/gitlab-org/gitlab/-/issues/211410) in GitLab 13.4.
> - It's enabled on GitLab.com. > - It's enabled on GitLab.com.
> - It can be disabled per-project. > - It can be disabled per-project.
> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enabling-the-feature). **(CORE ONLY)** > - For GitLab self-managed instances, GitLab administrators can opt to [disable it](#enable-or-disable-code-coverage-visualization). **(CORE ONLY)**
With the help of [GitLab CI/CD](../../../ci/README.md), you can collect the test With the help of [GitLab CI/CD](../../../ci/README.md), you can collect the test
coverage information of your favorite testing or coverage-analysis tool, and visualize coverage information of your favorite testing or coverage-analysis tool, and visualize
...@@ -74,26 +74,26 @@ test: ...@@ -74,26 +74,26 @@ test:
cobertura: coverage/cobertura-coverage.xml cobertura: coverage/cobertura-coverage.xml
``` ```
## Enabling the feature ## Enable or disable code coverage visualization
This feature comes with the `:coverage_report_view` feature flag enabled by This feature comes with the `:coverage_report_view` feature flag enabled by
default. It is enabled on GitLab.com. [GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md) default. It is enabled on GitLab.com. [GitLab administrators with access to the GitLab Rails console](../../../administration/feature_flags.md)
can disable it for your instance. Test coverage visualization can be enabled or disabled per-project. can disable it for your instance. Test coverage visualization can be enabled or disabled per-project.
To enable it: To disable it:
```ruby ```ruby
# Instance-wide # Instance-wide
Feature.enable(:coverage_report_view) Feature.disable(:coverage_report_view)
# or by project # or by project
Feature.enable(:coverage_report_view, Project.find(<project id>)) Feature.disable(:coverage_report_view, Project.find(<project id>))
``` ```
To disable it: To enable it:
```ruby ```ruby
# Instance-wide # Instance-wide
Feature.disable(:coverage_report_view) Feature.enable(:coverage_report_view)
# or by project # or by project
Feature.disable(:coverage_report_view, Project.find(<project id>)) Feature.enable(:coverage_report_view, Project.find(<project id>))
``` ```
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