Code Quality

Introduced in GitLab Starter 9.3.

Overview

If you are using GitLab CI/CD, you can analyze your source code quality using GitLab Code Quality. Code Quality uses Code Climate Engines, which are free and open source. Code Quality doesn’t require a Code Climate subscription.

Going a step further, GitLab can show the Code Quality report right in the merge request widget area:

Code Quality Widget

Use cases

For instance, consider the following workflow:

  1. Your backend team member starts a new implementation for making certain feature in your app faster
  2. With Code Quality reports, they analyze how their implementation is impacting the code quality
  3. The metrics show that their code degrade the quality in 10 points
  4. You ask a co-worker to help them with this modification
  5. They both work on the changes until Code Quality report displays no degradations, only improvements
  6. You approve the merge request and authorize its deployment to staging
  7. Once verified, their changes are deployed to production

How it works

First of all, you need to define a job in your .gitlab-ci.yml file that generates the Code Quality report artifact.

The Code Quality report artifact is a subset of the Code Climate spec. It must be a JSON file containing an array of objects with the following properties:

Name Description
description A description of the code quality violation.
fingerprint A unique fingerprint to identify the code quality violation. For example, an MD5 hash.
location.path The relative path to the file containing the code quality violation.
location.lines.begin The line on which the code quality violation occurred.

Example:

[
  {
    "description": "'unused' is assigned a value but never used.",
    "fingerprint": "7815696ecbf1c96e6894b779456d330e",
    "location": {
      "path": "lib/index.js",
      "lines": {
        "begin": 42
      }
    }
  }
]

Note: Note: Although the Code Climate spec supports more properties, those are ignored by GitLab.

For more information on how the Code Quality job should look like, check the example on analyzing a project’s code quality.

GitLab then checks this report, compares the metrics between the source and target branches, and shows the information right on the merge request.

Caution: Caution: If multiple jobs in a pipeline generate a code quality artifact, only the artifact from the last created job (the job with the largest job ID) is used. To avoid confusion, configure only one job to generate a code quality artifact.

Note: Note: If the Code Quality report doesn’t have anything to compare to, no information will be displayed in the merge request area. That is the case when you add the Code Quality job in your .gitlab-ci.yml for the very first time. Consecutive merge requests will have something to compare to and the Code Quality report will be shown properly.