Rename code climate to code quality
This commit is contained in:
Achilleas Pipinellis (🌴 July 10 - July 20 🌴)
Marcia Ramos
parent
6152d7a33e
commit
ee740d5ee0
|
|
@ -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)
|
||||
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
|
|
|||
|
|
@ -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/
|
||||
|
|
@ -297,7 +297,7 @@ out.
|
|||
|
||||
In GitLab Starter, differences between the source and
|
||||
target branches are also
|
||||
[shown in the merge request widget](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html).
|
||||
[shown in the merge request widget](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html).
|
||||
|
||||
### Auto SAST **[ULTIMATE]**
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ With **[GitLab Enterprise Edition][ee]**, you can also:
|
|||
|
||||
- View the deployment process across projects with [Multi-Project Pipeline Graphs](https://docs.gitlab.com/ee/ci/multi_project_pipeline_graphs.html#multi-project-pipeline-graphs) **[PREMIUM]**
|
||||
- Request [approvals](https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html) from your managers **[STARTER]**
|
||||
- Analyze the impact of your changes with [Code Quality reports](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html) **[STARTER]**
|
||||
- Analyze the impact of your changes with [Code Quality reports](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) **[STARTER]**
|
||||
|
||||
## Use cases
|
||||
|
||||
|
|
@ -43,7 +43,7 @@ A. Consider you are a software developer working in a team:
|
|||
|
||||
1. You checkout a new branch, and submit your changes through a merge request
|
||||
1. You gather feedback from your team
|
||||
1. You work on the implementation optimizing code with [Code Quality reports](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html) **[STARTER]**
|
||||
1. You work on the implementation optimizing code with [Code Quality reports](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) **[STARTER]**
|
||||
1. You build and test your changes with GitLab CI/CD
|
||||
1. You request the approval from your manager
|
||||
1. Your manager pushes a commit with his final review, [approves the merge request](https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html), and set it to [merge when pipeline succeeds](#merge-when-pipeline-succeeds) (Merge Request Approvals are available in GitLab Starter)
|
||||
|
|
|
|||
Loading…
Reference in New Issue