Skip to content
Snippets Groups Projects
Commit 5d8fb98b authored by Fabio Pitino's avatar Fabio Pitino
Browse files

Add README.md

parent f4b1b4d4
No related branches found
No related tags found
No related merge requests found
Inputs:
Variables:
- CODE_QUALITY_DISABLED: do not add job to the pipeline.
Variables:
# Code Quality
Use Code Quality to analyze your source code's quality and complexity. This helps keep your project's code simple, readable, and easier to maintain. Code Quality should supplement your other review processes, not replace them.
Code Quality uses the open source Code Climate tool, and selected [plugins](https://docs.codeclimate.com/docs/list-of-engines)
to analyze your source code.
To confirm if your code's languages are covered, see the Code Climate list of [Supported Languages for Maintainability](https://docs.codeclimate.com/docs/supported-languages-for-maintainability).
You can extend the code coverage either by using [Code Climate Analysis Plugins](https://docs.codeclimate.com/docs/list-of-engines) or a [custom tool](https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool).
Run Code Quality reports in your CI/CD pipeline to verify changes don't degrade your code's quality, before committing them to the default branch.
Learn more at https://docs.gitlab.com/ee/ci/testing/code_quality.html
## Usage
Use this component to scan your source code and get a report about code quality and complexity.
You should add this component to an existing `.gitlab-ci.yml` file by using the `include:`
keyword.
```yaml
include:
- component: gitlab.com/gitlab-components/code-qualityg@<VERSION>
```
where `<VERSION>` is the latest released tag or `main`.
### Inputs
| Input | Default value | Description |
| ----- | ------------- | ----------- |
| `stage` | `test` | The stage where you want the job to be added |
| `image` | `$CI_TEMPLATE_REGISTRY_HOST/gitlab-org/ci-cd/codequality:0.94.0` | The Docker image of the analyzer |
### Variables
You can customize details of the quality analyzer by setting the following variables: https://docs.gitlab.com/ee/ci/testing/code_quality.html#available-cicd-variables
## Contribute
- CODE_QUALITY_DISABLED: do not add job to the pipeline.
\ No newline at end of file
To contribute improvements to CI/CD templates, follow the Development guide at:
https://docs.gitlab.com/ee/development/cicd/templates.html
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment