Optimize and improve the inline documentation for the codequality job

.gitlab-ci.yml

@@ -619,7 +619,9 @@ codequality:
   cache: {}
   dependencies: []
   script:
-    - ./scripts/codequality analyze -f json > codeclimate.json || true
+    - ./scripts/codequality analyze -f json > raw_codeclimate.json || true
+    # The following line keeps only the fields used in the MR widget, reducing the JSON artifact size
+    - cat raw_codeclimate.json | docker run -i stedolan/jq -c 'map({check_name,description,fingerprint,location})' > codeclimate.json
   artifacts:
     paths: [codeclimate.json]
     expire_in: 1 week

scripts/codequality

@@ -8,6 +8,7 @@ code_path=$(pwd)
 # it will break codequality json file
 [ "$CI" != "" ] || docker_tty="--tty"
 
+# The codebase and instructions for the following image can be found at https://gitlab.com/gitlab-org/codeclimate-rubocop/wikis/home
 docker pull dev.gitlab.org:5005/gitlab/gitlab-build-images:gitlab-codeclimate-rubocop-0-52-1 > /dev/null
 docker tag dev.gitlab.org:5005/gitlab/gitlab-build-images:gitlab-codeclimate-rubocop-0-52-1 codeclimate/codeclimate-rubocop:gitlab-codeclimate-rubocop-0-52-1 > /dev/null