diff options
author | Olivier Gonzalez <ogonzalez@gitlab.com> | 2018-05-18 19:47:51 +0300 |
---|---|---|
committer | Olivier Gonzalez <ogonzalez@gitlab.com> | 2018-05-24 02:26:57 +0300 |
commit | dd639aad8d0d24386c6b7bba0ec4a120dbd2027b (patch) | |
tree | 7e8f72e6979f3dda00092409a87d3ce2b37fe3e0 /doc/ci | |
parent | 6c51e220ef2774447038a909c4f22ff90eb624fb (diff) |
Rename code quality job and artifact. Refs gitlab-org/gitlab-ee#5779
Diffstat (limited to 'doc/ci')
-rw-r--r-- | doc/ci/examples/code_climate.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/ci/examples/code_climate.md b/doc/ci/examples/code_climate.md index d1aa783cc9c..de49c34130f 100644 --- a/doc/ci/examples/code_climate.md +++ b/doc/ci/examples/code_climate.md @@ -5,10 +5,10 @@ GitLab CI and Docker. First, you need GitLab Runner with [docker-in-docker executor][dind]. -Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `codequality`: +Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `code_quality`: ```yaml -codequality: +code_quality: image: docker:stable variables: DOCKER_DRIVER: overlay2 @@ -23,18 +23,18 @@ codequality: --volume /var/run/docker.sock:/var/run/docker.sock "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code artifacts: - paths: [codeclimate.json] + paths: [gl-code-quality-report.json] ``` -The above example will create a `codequality` job in your CI/CD pipeline which +The above example will create a `code_quality` job in your CI/CD pipeline which will scan your source code for code quality issues. The report will be saved as an artifact that you can later download and analyze. TIP: **Tip:** Starting with [GitLab Starter][ee] 9.3, this information will be automatically extracted and shown right in the merge request widget. To do -so, the CI/CD job must be named `codequality` and the artifact path must be -`codeclimate.json`. +so, the CI/CD job must be named `code_quality` and the artifact path must be +`gl-code-quality-report.json`. [Learn more on code quality diffs in merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html). [cli]: https://github.com/codeclimate/codeclimate |