summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShinya Maeda <shinya@gitlab.com>2017-08-25 23:48:57 +0900
committerShinya Maeda <shinya@gitlab.com>2017-08-31 15:52:21 +0900
commit9dd8af01fee78b828cfe3b6c8395a57d7a3d011a (patch)
treeb9e4803846a9083ec9aeb9fe3ce18f263e3769f1
parentff5918d3a6c0bbce159c60544138f182c2625692 (diff)
downloadgitlab-ce-9dd8af01fee78b828cfe3b6c8395a57d7a3d011a.tar.gz
Squashed commit of the following:
commit 79858a631af97c2857700fa44c0e7ba09d621e12 Author: Shinya Maeda <shinya@gitlab.com> Date: Fri Aug 25 23:33:04 2017 +0900 Fix doc commit d0c864c7f1522bd254458a7d6e1002352f34a143 Author: Shinya Maeda <shinya@gitlab.com> Date: Tue Aug 22 22:27:32 2017 +0900 Add tests commit 1628eb8598f8ad0e6b573f3fb4fdcf5c3776885b Author: Shinya Maeda <shinya@gitlab.com> Date: Tue Aug 22 10:14:44 2017 +0000 Update .gitlab-ci.yml commit 440a3cdd0bb5d7b83f861f6d3762510b40df984a Author: Shinya Maeda <shinya@gitlab.com> Date: Fri Aug 18 14:46:56 2017 +0000 Update build.rb commit e925951e35c889bfc0520ce056e7df7befdeb93b Author: Shinya Maeda <shinya@gitlab.com> Date: Thu Aug 17 18:13:17 2017 +0900 Add changelog commit 7de5b4f50fc1ff6987c9a861c057c816d4fb285d Author: Shinya Maeda <shinya@gitlab.com> Date: Thu Aug 17 18:11:53 2017 +0900 ini
-rw-r--r--doc/ci/examples/README.md5
-rw-r--r--doc/ci/examples/code_climate.md8
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/ci/examples/README.md b/doc/ci/examples/README.md
index 2458cb959ab..f094546c3bd 100644
--- a/doc/ci/examples/README.md
+++ b/doc/ci/examples/README.md
@@ -50,12 +50,15 @@ Apart from those, here is an collection of tutorials and guides on setting up yo
- **Articles:**
- [Setting up GitLab CI for Android projects](https://about.gitlab.com/2016/11/30/setting-up-gitlab-ci-for-android-projects/)
+### Code quality analysis
+
+- [Analyze code quality with the Code Climate CLI](code_climate.md)
+
### Other
- [Using `dpl` as deployment tool](deployment/README.md)
- [Repositories with examples for various languages](https://gitlab.com/groups/gitlab-examples)
- [The .gitlab-ci.yml file for GitLab itself](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/.gitlab-ci.yml)
-- [Analyze code quality with the Code Climate CLI](code_climate.md)
- **Articles:**
- [Continuous Deployment with GitLab: how to build and deploy a Debian Package with GitLab CI](https://about.gitlab.com/2016/10/12/automated-debian-package-build-with-gitlab-ci/)
diff --git a/doc/ci/examples/code_climate.md b/doc/ci/examples/code_climate.md
index 5659a8c2a2a..b9963995ca7 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 `codeclimate`:
+Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `codequality` or `codeclimate`(DEPRECATED[^1]):
```yaml
-codeclimate:
+codequality:
image: docker:latest
variables:
DOCKER_DRIVER: overlay
@@ -22,13 +22,15 @@ codeclimate:
paths: [codeclimate.json]
```
-This will create a `codeclimate` job in your CI pipeline and will allow you to
+This will create a `codequality` job in your CI pipeline and will allow you to
download and analyze the report artifact in JSON format.
For GitLab [Enterprise Edition Starter][ee] users, this information can be automatically
extracted and shown right in the merge request widget. [Learn more on code quality
diffs in merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html).
+[^1]: This is scheduled to be removed in 11.0.
+
[cli]: https://github.com/codeclimate/codeclimate
[dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor
[ee]: https://about.gitlab.com/gitlab-ee/