prince695 / linux-cmake-gh-actions-sq

An example C++ repository built with CMake on Linux using GitHub Actions and analyzed on SonarQube

C++ example project scanned on SonarQube using GitHub Actions

This project is analysed on SonarQube!

ℹ️	This simple example ignores analysis cache and multithreaded execution both of which can boost analysis significantly.

It is very easy to analyze a C, C++ and Objective-C project with SonarQube:

1. Create a sonar-project.properties file to store your configuration

2. In your .github/workflows/build.yml file:

   1. Set the environment variable SONAR_SERVER_URL to your server url (e.g.: https://example.com:9000)

   2. Download the Sonar Scanner

   3. Download the Build Wrapper

   4. Wrap your compilation with the Build Wrapper

   5. Run sonar-scanner as the final step

3. Make sure that you have your token stored as a secret in your repository (SONAR_TOKEN). 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.

Documentation

• Documentation of the C, C++ and Objective-C plugin and its Build Wrapper

• GitHub Integration in SonarQube

• Configuring C, C++ and Objective-C analysis cache

• Configuring multithreaded execution

Linux\CMake

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

Code Description

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:

• Linux

• MacOS

• Windows

Using the following build systems:

• CMake

• GNU Autotools

• Xcode

• MSBuild

Running on the following CI services:

• Azure DevOps

• GitHub Actions

• Travis

• Jenkins

• GitLab CI

• BitBucket Pipelines

• Additionally, generic examples demonstrate integration with other CIs and manual-configuration examples should help you if you are running locally.

Configured for analysis on:

• SonarQube

• SonarCloud

You can find also a few examples demonstrating:

• The use of Compilation Database (compile_commands.json)

• Test coverage

See examples-structure.adoc for a description of the structure of this GitHub organization and the relations between its different repositories.