Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
396a1cb1
Commit
396a1cb1
authored
Jul 31, 2020
by
Ricky Wiens
Committed by
Marcel Amirault
Jul 31, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Remove previous code quality definitions
- The previous definitions are no longer recommended to be used.
parent
e1253828
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
3 additions
and
104 deletions
+3
-104
doc/user/project/merge_requests/code_quality.md
doc/user/project/merge_requests/code_quality.md
+3
-104
No files found.
doc/user/project/merge_requests/code_quality.md
View file @
396a1cb1
...
...
@@ -67,12 +67,10 @@ For instance, consider the following workflow:
## Example configuration
CAUTION:
**Caution:**
The job definition shown below is supported on GitLab 11.11 and later versions. It
also requires the GitLab Runner 11.5 or later. For earlier versions, use the
[
previous job definitions
](
#previous-job-definitions
)
.
This example shows how to run Code Quality on your code by using GitLab CI/CD and Docker.
It requires GitLab 11.11 or later, and GitLab Runner 11.5 or later. If you are using
GitLab 11.4 or ealier, you can view the deprecated job definitions in the
[
documentation archive
](
https://docs.gitlab.com/12.10/ee/user/project/merge_requests/code_quality.html#previous-job-definitions
)
.
First, you need GitLab Runner configured:
...
...
@@ -132,105 +130,6 @@ definition they will be able to execute privileged Docker commands on the Runner
host. Having proper access control policies mitigates this attack vector by
allowing access only to trusted actors.
### Previous job definitions
CAUTION:
**Caution:**
Before GitLab 11.5, Code Quality job and artifact had to be named specifically to
automatically extract report data and show it in the merge request widget. While these
old job definitions are still maintained they have been deprecated and are no longer supported on GitLab 12.0 or higher.
You're advised to update your
`.gitlab-ci.yml`
configuration to reflect that change.
For GitLab 11.5 and later, the job should look like:
```
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/ci-cd/codequality:$SP_VERSION" /code
artifacts
:
reports
:
codequality
:
gl-code-quality-report.json
```
In GitLab 12.6, Code Quality switched to the
[
new versioning scheme
](
https://gitlab.com/gitlab-org/ci-cd/codequality#versioning-and-release-cycle
)
.
It's highly recommended to include the Code Quality template as shown in the
[
example configuration
](
#example-configuration
)
, which uses the new versioning scheme.
If not using the template, the
`SP_VERSION`
variable can be hardcoded to use the
new image versions:
```
yaml
code_quality
:
image
:
docker:stable
variables
:
DOCKER_DRIVER
:
overlay2
SP_VERSION
:
0.85.6
allow_failure
:
true
services
:
-
docker:stable-dind
script
:
-
docker run
--env SOURCE_CODE="$PWD"
--volume "$PWD":/code
--volume /var/run/docker.sock:/var/run/docker.sock
"registry.gitlab.com/gitlab-org/ci-cd/codequality:$SP_VERSION" /code
artifacts
:
reports
:
codequality
:
gl-code-quality-report.json
```
For GitLab 11.4 and earlier, the job should look like:
```
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/ci-cd/codequality:$SP_VERSION" /code
artifacts
:
paths
:
[
gl-code-quality-report.json
]
```
Alternatively the job name could be
`codeclimate`
or
`codequality`
and the artifact
name could be
`codeclimate.json`
. These names have been deprecated with GitLab 11.0
and may be removed in the next major release, GitLab 12.0.
For GitLab 10.3 and earlier, the job should look like:
```
yaml
codequality
:
image
:
docker:latest
variables
:
DOCKER_DRIVER
:
overlay
services
:
-
docker:dind
script
:
-
docker pull codeclimate/codeclimate:0.69.0
-
docker run --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc codeclimate/codeclimate:0.69.0 init
-
docker run --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc codeclimate/codeclimate:0.69.0 analyze -f json > codeclimate.json ||
true
artifacts
:
paths
:
[
codeclimate.json
]
```
## Configuring jobs using variables
The Code Quality job supports environment variables that users can set to
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment