Commit d4358566 authored by Shinya Maeda's avatar Shinya Maeda

Fix doc

parent 2c98b42e
...@@ -5,7 +5,7 @@ GitLab CI and Docker. ...@@ -5,7 +5,7 @@ GitLab CI and Docker.
First, you need GitLab Runner with [docker-in-docker executor][dind]. 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` or `codeclimate`(DEPRECATED[^1]): Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `codequality`:
```yaml ```yaml
codequality: codequality:
...@@ -29,8 +29,6 @@ For GitLab [Enterprise Edition Starter][ee] users, this information can be autom ...@@ -29,8 +29,6 @@ For GitLab [Enterprise Edition Starter][ee] users, this information can be autom
extracted and shown right in the merge request widget. [Learn more on code quality extracted and shown right in the merge request widget. [Learn more on code quality
diffs in merge requests](../../user/project/merge_requests/code_quality_diff.md). diffs in merge requests](../../user/project/merge_requests/code_quality_diff.md).
[^1]: This is scheduled to be removed in 11.0.
[cli]: https://github.com/codeclimate/codeclimate [cli]: https://github.com/codeclimate/codeclimate
[dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor [dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor
[ee]: https://about.gitlab.com/gitlab-ee/ [ee]: https://about.gitlab.com/gitlab-ee/
...@@ -27,6 +27,12 @@ For instance, consider the following workflow: ...@@ -27,6 +27,12 @@ For instance, consider the following workflow:
## How it works ## How it works
>**Note:**
In [GitLab Enterprise Edition Starter][ee] 10.0, another job name will
also be supported: `codequality`. This new job name will eventually replace
`codeclimate` which is scheduled to be removed in GitLab 11.0. You are advised
to update your current `.gitlab-ci.yml` configuration to reflect that change.
In order for the report to show in the merge request, you need to specify a In order for the report to show in the merge request, you need to specify a
`codequality` job (exact name) that will analyze the code and upload the resulting `codequality` job (exact name) that will analyze the code and upload the resulting
`codeclimate.json` as an artifact. GitLab will then check this file and show `codeclimate.json` as an artifact. GitLab will then check this file and show
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment