diff options
author | Achilleas Pipinellis (🌴 July 10 - July 20 🌴) <axil@gitlab.com> | 2018-07-10 15:39:55 +0300 |
---|---|---|
committer | Marcia Ramos <virtua.creative@gmail.com> | 2018-07-10 15:39:55 +0300 |
commit | ee740d5ee0e0a9a2dda9e55102ec37c63a098783 (patch) | |
tree | 9e9ea40bf9753b773a5674085d9ebad892cc895f /doc/ci | |
parent | 6152d7a33e177f8b656f104a7e7d93c3a5562394 (diff) |
Rename code climate to code quality
Diffstat (limited to 'doc/ci')
-rw-r--r-- | doc/ci/examples/README.md | 4 | ||||
-rw-r--r-- | doc/ci/examples/code_climate.md | 53 | ||||
-rw-r--r-- | doc/ci/examples/code_quality.md | 49 |
3 files changed, 56 insertions, 50 deletions
diff --git a/doc/ci/examples/README.md b/doc/ci/examples/README.md index aa31e172641..811f4d1f07a 100644 --- a/doc/ci/examples/README.md +++ b/doc/ci/examples/README.md @@ -43,9 +43,9 @@ There's also a collection of repositories with [example projects](https://gitlab - [Using `dpl` as deployment tool](deployment/README.md) - [The `.gitlab-ci.yml` file for GitLab itself](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/.gitlab-ci.yml) -## Code quality analysis +## Code Quality analysis -[Analyze code quality with the Code Climate CLI](code_climate.md). +**(Starter)** [Analyze your project's Code Quality](code_quality.md). ## Static Application Security Testing (SAST) diff --git a/doc/ci/examples/code_climate.md b/doc/ci/examples/code_climate.md index 2c8865c6e50..b34637efc8d 100644 --- a/doc/ci/examples/code_climate.md +++ b/doc/ci/examples/code_climate.md @@ -1,49 +1,6 @@ -# Analyze project code quality with Code Climate CLI +--- +redirect_from: 'https://docs.gitlab.com/ee/ci/examples/code_climate.html' +redirect_to: code_quality.md +--- -This example shows how to run [Code Climate CLI][cli] on your code by using -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 `code_quality`: - -```yaml -code_quality: - image: docker:stable - variables: - DOCKER_DRIVER: overlay2 - allow_failure: true - services: - - docker:stable-dind - script: - - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/') - - docker run - --env SOURCE_CODE="$PWD" - --volume "$PWD":/code - --volume /var/run/docker.sock:/var/run/docker.sock - "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code - artifacts: - paths: [gl-code-quality-report.json] -``` - -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 `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). - -CAUTION: **Caution:** -Code Quality was previously using `codeclimate` and `codequality` for job name and -`codeclimate.json` for the artifact name. While these old names -are still maintained they have been deprecated with GitLab 11.0 and may be removed -in next major release, GitLab 12.0. You are advised to update your current `.gitlab-ci.yml` -configuration to reflect that change. - -[cli]: https://github.com/codeclimate/codeclimate -[dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor -[ee]: https://about.gitlab.com/pricing/ +This document was moved to [another location](code_quality.md). diff --git a/doc/ci/examples/code_quality.md b/doc/ci/examples/code_quality.md new file mode 100644 index 00000000000..2a7040ecdeb --- /dev/null +++ b/doc/ci/examples/code_quality.md @@ -0,0 +1,49 @@ +# Analyze your project's Code Quality + +This example shows how to run Code Quality on your code by using GitLab CI/CD +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 `code_quality`: + +```yaml +code_quality: + image: docker:stable + variables: + DOCKER_DRIVER: overlay2 + allow_failure: true + services: + - docker:stable-dind + script: + - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/') + - docker run + --env SOURCE_CODE="$PWD" + --volume "$PWD":/code + --volume /var/run/docker.sock:/var/run/docker.sock + "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code + artifacts: + paths: [gl-code-quality-report.json] +``` + +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 `code_quality` and the artifact path must be +`gl-code-quality-report.json`. +[Learn more on Code Quality in merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html). + +CAUTION: **Caution:** +Code Quality was previously using `codeclimate` and `codequality` for job name and +`codeclimate.json` for the artifact name. While these old names +are still maintained they have been deprecated with GitLab 11.0 and may be removed +in next major release, GitLab 12.0. You are advised to update your current `.gitlab-ci.yml` +configuration to reflect that change. + +[cli]: https://github.com/codeclimate/codeclimate +[dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor +[ee]: https://about.gitlab.com/pricing/ |