This project is analysed on SonarQube!
It is very easy to analyze a C, C++ and Objective-C project with SonarQube using compilation database:
-
Create a
sonar-project.properties
file to store your configuration -
In your
.github/workflows/build.yml
file:-
Set the environment variable
SONAR_HOST_URL
to your server url (e.g.: https://example.com:9000) -
Download the Sonar Scanner
-
Generate the compilation database file (set
CMAKE_EXPORT_COMPILE_COMMANDS
toON
) -
Run
sonar-scanner
with the propertysonar.cfamily.compile-commands
set to your compilation database file
-
-
Ensure that your token is stored as a secret in your repository (
SONARQUBE_TOKEN
in this example project). If you don’t have a token yet, you can generate a new one in SonarQube (see Generating and Using Tokens).
You can take a look at the sonar-project.properties and build.yml to see it in practice.
A build of the code repository on a Linux platform using CMake build system.
To build the code run:
mkdir build && cd build cmake .. make
An example of a flawed C++ code. The code repository is meant to be compiled with different build systems using different CI pipelines on Linux, macOS, and Windows.
The code repository is forked into other repositories in this collection to add a specific build system, platform, and CI. The downstream repositories are analyzed either with SonarQube or SonarCloud.
You can find examples for:
Using the following build systems:
Running on the following CI services:
-
Additionally, generic examples demonstrate integration with other CIs and manual-configuration examples should help you if you are running locally.
Configured for analysis on:
You can find also a few examples demonstrating:
See examples-structure.adoc for a description of the structure of this GitHub organization and the relations between its different repositories.