Code Quality [STARTER]

Introduced in GitLab Starter 9.3.


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 Code Quality can show the Code Climate 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

In order for the report to show in the merge request, you need to specify a code_quality job (exact name) that will analyze the code and upload the resulting gl-code-quality-report.json as an artifact. GitLab will then check this file and show the information inside the merge request.

Note: If the Code Climate 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.

For more information on how the code_quality job should look like, check the example on analyzing a project's code quality with Code Climate CLI.

CAUTION: Caution: Code Quality was previously using codeclimate and codequality for job name and codeclimate.json for the artifact name. While these old names are still maintained they have been deprecated with GitLab 11.0 and may be removed in next major release, GitLab 12.0. You are advised to update your current .gitlab-ci.yml configuration to reflect that change.