Skip to content

Optimize and improve the inline documentation for the codequality job

Rémy Coutable requested to merge ad-inline-doc-to-codequality-job into master

What does this MR do?

  1. This optimizes the codequality job by keeping only the fields that are used in the MR widget, allowing to reduce the JSON artifact
  2. This adds some inline comments to explain why we do certain things in the codequality job

Why was this MR needed?

Because that was confusing, e.g. "Where can I found the codeclimate-rubocop Docker image codebase?" or "What is the purpose of docker run -i stedolan/jq -c 'map({check_name,description,fingerprint,location})'?"

Does this MR meet the acceptance criteria?

Edited by Dmytro Zaporozhets (DZ)

Merge request reports