python/qa¶
Configures all jobs to perform quality assurance (Q/A) scans of your Python project.
Description¶
This meta-component combines the following individual components
Usage¶
include:
- component: git.ligo.org/computing/gitlab/components/python/qa@<VERSION>
Inputs¶
| Input | Default value | Description |
|---|---|---|
stage | test | Pipeline stage to add jobs to |
python | "python" | Name of the Python interpreter to use for python/code-quality |
requirements | None | Extra requirements to install with pip for python/code-quality. |
code_quality_analyzer | "flake8" | Code quality analyzer to configure |
code_quality_options | "" | Options to pass to the code quality analyzer |
run_advanced_sast | false | Use GitLab Advanced SAST |
sast_excluded_paths | "spec, test, tests, tmp" | Paths to exclude from SAST (comma-separated string) |
sast_excluded_analyzers | "" | Analyzers to exclude from SAST (comma-separated string) |
run_advanced_sast will default to true in version 2
The run_advanced_sast input will be updated to default to true starting in version 2 of this component.
To opt-in, or opt-out of the new default now, add the run_advanced_sast input option to your CI/CD configuration.
Customisation¶
See the Customisation sections for the relevant sub-components for any other relevant details.
Examples¶
Configure complete quality-assurance scanning for a Python project
include:
- component: git.ligo.org/computing/gitlab/components/python/qa@<VERSION>
inputs:
code_quality_analyzer: ruff