sonarsource-cfamily-examples / linux-autotools-gh-actions-sc

An example C++ repository built with GNU Autotools (automake; configure/make) on Linux using GitHub Actions and analyzed on SonarCloud

C++ example project scanned on SonarCloud using GitHub Actions

This project is analysed on SonarCloud!

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

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

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

   1. Download the Sonar Scanner and Build Wrapper using SonarCloud C and C++ Github Action

   2. Wrap your compilation with the Build Wrapper

   3. Run sonar-scanner as the final step

3. Ensure that your token is stored as a secret in your repository (SONARCLOUD_TOKEN in this example project). You can request new tokens using Account/Security page.

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

• Documentation of using SonarCloud with GitHub

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

• Configuring multithreaded execution

• Using compilation database (compile_commands.json)

• GitHub Action for C and C++ usage

Linux\Autotools

A build of the code repository on a Linux platform using GNU Autotools build system.

To build the code run:

autoreconf --install
./configure
make clean all

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.