Infrastructure/GitLab/CI/Static Code Analysis: Difference between revisions
| Line 6: | Line 6: | ||
The GitLab CI pipeline for each project is defined in project's <code>.gitlab-ci.yml</code> file, which must be placed in the top-level directory of the project's git repository. | The GitLab CI pipeline for each project is defined in project's <code>.gitlab-ci.yml</code> file, which must be placed in the top-level directory of the project's git repository. | ||
Below are examples of default configuration that you need to add to the <code>.gitlab-ci.yml</code> file in order to get the static analysis jobs working. The configuration is slightly different based on whether your project is part of Frameworks, Applications or Extragear "groups", or whether it's a completely standalone project (e.g. a personal project). | |||
=== Frameworks, Applications and Extragear projects === | === Frameworks, Applications and Extragear projects === | ||
include: | |||
- https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-before.yml | |||
- https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-<PRODUCT>-linux.yml | |||
- https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-static-analysis.yml | |||
static-analysis-linux-merge-request: | |||
extends: .static-analysis-linux-merge-request | |||
static-analysis-linux-commit: | |||
extends: .static-analysis-linux-commit | |||
Replace <code><PRODUCT></code> with the lower-case name of the product your application belongs to, i.e. <code>frameworks</code>, <code>applications</code> or <code>extragear</code>. | |||
=== Playground/Miscellaneous projects === | === Playground/Miscellaneous projects === | ||
include: | |||
- https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-before.yml | |||
- https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-playground-linux.yml | |||
- https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-static-analysis.yml | |||
static-analysis-linux-merge-request: | |||
extends: .static-analysis-linux-merge-request | |||
static-analysis-linux-commit: | |||
extends: .static-analysis-linux-commit | |||
== Customizing the static analyzer jobs == | == Customizing the static analyzer jobs == | ||
Revision as of 11:25, 7 September 2020
Motivation
Static code analysis is a helpful tool to improve and keep high level of code quality. Static code analyzer inspects the source code and looks for issues like wrong usage of some API, bugprone statements, potential performance issues and many others. The static analyzers available on our KDE instance of GitLab are clazy and clang-tidy. Since both of those analyzers are based on the clang C++ compiler, the issues the analyzers find are reported as regular compiler warnings.
Setting up
The GitLab CI pipeline for each project is defined in project's .gitlab-ci.yml file, which must be placed in the top-level directory of the project's git repository.
Below are examples of default configuration that you need to add to the .gitlab-ci.yml file in order to get the static analysis jobs working. The configuration is slightly different based on whether your project is part of Frameworks, Applications or Extragear "groups", or whether it's a completely standalone project (e.g. a personal project).
Frameworks, Applications and Extragear projects
include: - https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-before.yml - https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-<PRODUCT>-linux.yml - https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-static-analysis.yml static-analysis-linux-merge-request: extends: .static-analysis-linux-merge-request static-analysis-linux-commit: extends: .static-analysis-linux-commit
Replace <PRODUCT> with the lower-case name of the product your application belongs to, i.e. frameworks, applications or extragear.
Playground/Miscellaneous projects
include: - https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-before.yml - https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-playground-linux.yml - https://invent.kde.org/sysadmin/ci-tooling/raw/master/invent/ci-static-analysis.yml static-analysis-linux-merge-request: extends: .static-analysis-linux-merge-request static-analysis-linux-commit: extends: .static-analysis-linux-commit
Customizing the static analyzer jobs
TODO
Clazy
Intro TODO
Configuring Clazy
TODO
Supressing warnings
TODO
Clang-tidy
Intro TODO
Configuring Clang-tidy
TODO
Supressing warnings
TODO