/
Viewing the code quality report

Viewing the code quality report

Owned by Akshay Aggarwal (Unlicensed)
Last updated: Aug 28, 2020
3 min read

What is the purpose of the Article?

  • You will understand how to view the code quality report generated in Gitlab in Eshopbox

Audience

  • Software Development Engineers

How to View the generated Code Quality report

  • Go to “Merge Requests” from the options in the toolbar on the left side. A window will open as shown:

  • Click on the merge request assigned to you and you will be redirected to a window as shown below:

  • As you can see a Detached merge request pipeline has been created and is running. This is the pipeline that will generate the code quality report.

  • Under “CI/CD option” from the options in the toolbar on the left side click on “Pipelines”. A window with all the pipelines as shown below will open. Click on the latest detached pipeline as shown

  • You will be redirected to a window as shown below

  • Click on “Code Quality” and you will see the report as below

  • Go through the report and if any check or rule is breached, mention in the comments section.

  • The author will make the changes accordingly and submit a new merge request.

  • The approver will again check the code quality report and if everything is within the specified threshold range, the approver will approve and merge the request.

Troubleshooting

Changing the default configuration has no effect

A common issue is that the terms Code Quality (GitLab specific) and Code Climate (Engine used by GitLab) are very similar. You must add a .codeclimate.yml file to change the default configuration, not a .codequality.yml file. If you use the wrong filename, the default .codeclimate.yml is still used.

No Code Quality report is displayed in a Merge Request

This can be due to multiple reasons:

  • You just added the Code Quality job in your .gitlab-ci.yml. The report does not have anything to compare to yet, so no information can be displayed. Future merge requests will have something to compare to.

  • Your pipeline is not set to run the code quality job on your default branch. If there is no report generated from the default branch, your MR branch reports will not have anything to compare to.

  • If no degradation or error is detected, nothing will be displayed.

  • The artifacts:expire_in CI/CD setting can cause the Code Quality artifact(s) to expire faster than desired.

  • Large codeclimate.json files (esp. >10 MB) are known to prevent the report from being displayed. As a work-around, try removing properties that are ignored by GitLab. You can:

    • Configure the Code Quality tool to not output those types.

    • Use sed, awk or similar commands in the .gitlab-ci.yml script to edit the codeclimate.json before the job completes.

Only a single Code Quality report is displayed, but more are defined

GitLab only uses the Code Quality artifact from the latest created job (with the largest job ID). If multiple jobs in a pipeline generate a code quality artifact, those of earlier jobs are ignored. To avoid confusion, configure only one job to generate a codeclimate.json.

Related content