diff options
Diffstat (limited to 'doc/ci/testing/code_quality.md')
-rw-r--r-- | doc/ci/testing/code_quality.md | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/doc/ci/testing/code_quality.md b/doc/ci/testing/code_quality.md index fcb5a23742a..1d857b8f543 100644 --- a/doc/ci/testing/code_quality.md +++ b/doc/ci/testing/code_quality.md @@ -4,7 +4,7 @@ group: Static Analysis info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Code Quality **(FREE)** +# Code Quality **(FREE ALL)** > [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212499) to GitLab Free in 13.2. @@ -56,7 +56,7 @@ were introduced by the changes made in the merge request. ![Code Quality Widget](img/code_quality_widget_13_11.png) -### Merge request changes view **(ULTIMATE)** +### Merge request changes view **(ULTIMATE ALL)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/267612) in GitLab 13.11, disabled by default behind the `codequality_mr_diff` [feature flag](../../administration/feature_flags.md). > - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/284140) in GitLab 13.12. @@ -68,7 +68,7 @@ issues are marked by an indicator beside the gutter. Hover over the marker for d ![Code Quality MR diff report](img//code_quality_mr_diff_report_v15_7.png) -### Pipeline details view **(PREMIUM)** +### Pipeline details view **(PREMIUM ALL)** The full list of Code Quality violations generated by a pipeline is shown in the **Code Quality** tab of the pipeline's details page. The pipeline details view displays all Code Quality findings @@ -76,7 +76,7 @@ that were found on the branch it was run on. ![Code Quality Report](img/code_quality_report_13_11.png) -### Project quality view **(ULTIMATE)** +### Project quality view **(ULTIMATE ALL)** The project quality view displays an overview of the code quality findings. The view can be found under **Analyze > CI/CD analytics**, and requires [`project_quality_summary_page`](../../user/feature_flags.md) feature flag to be enabled for this particular project. @@ -136,7 +136,7 @@ To use private runners: ```shell $ gitlab-runner register --executor "docker" \ - --docker-image="docker:stable" \ + --docker-image="docker:latest" \ --url "https://gitlab.com/" \ --description "cq-sans-dind" \ --tag-list "cq-sans-dind" \ @@ -171,7 +171,7 @@ To use private runners: builds_dir = "/tmp/builds" [runners.docker] tls_verify = false - image = "docker:stable" + image = "docker:latest" privileged = false disable_entrypoint_overwrite = false oom_kill_disable = false @@ -454,13 +454,13 @@ You can integrate a custom tool into GitLab to provide Code Quality reports. The Code Quality report artifact JSON file must contain an array of objects with the following properties: -| Name | Description | -| ---------------------- | ----------------------------------------------------------------------------------------- | -| `description` | A description of the code quality violation. | -| `check_name` | A unique name representing the static analysis check that emitted this issue. | -| `fingerprint` | A unique fingerprint to identify the code quality violation. For example, an MD5 hash. | -| `severity` | A severity string (can be `info`, `minor`, `major`, `critical`, or `blocker`). | -| `location.path` | The relative path to the file containing the code quality violation. | +| Name | Description | +|-----------------------------------------------------------|-------------| +| `description` | A description of the code quality violation. | +| `check_name` | A unique name representing the static analysis check that emitted this issue. | +| `fingerprint` | A unique fingerprint to identify the code quality violation. For example, an MD5 hash. | +| `severity` | A severity string (can be `info`, `minor`, `major`, `critical`, or `blocker`). | +| `location.path` | The relative path to the file containing the code quality violation. | | `location.lines.begin` or `location.positions.begin.line` | The line on which the code quality violation occurred. | NOTE: @@ -630,8 +630,9 @@ To work around this problem, set `TIMEOUT_SECONDS` to a higher value in your `.g For example: ```yaml -variables: - TIMEOUT_SECONDS: 3600 +code_quality: + variables: + TIMEOUT_SECONDS: 3600 ``` ### Using Code Quality with Kubernetes CI executor |