From 3e3aca4a6742ce9567d3a3d5763710d21d1c847c Mon Sep 17 00:00:00 2001 From: Antonio Aversa Date: Thu, 19 Dec 2024 13:55:00 +0100 Subject: [PATCH] Update README.adoc --- README.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.adoc b/README.adoc index 6b13895..7570457 100644 --- a/README.adoc +++ b/README.adoc @@ -9,7 +9,7 @@ image:{img-build-status}[Build Status, link={uri-build-status}] image:{img-qg-status}[Quality Gate Status,link={uri-qg-status}] -*This project is analysed on https://next.sonarqube.com/sonarqube/dashboard?id=sonarsource-cfamily-examples_linux-autotools-gh-actions-sq_AYAYt8D0y0k_ZlpkA-ln[SonarQube]!* +*This project is analysed on https://next.sonarqube.com/sonarqube/dashboard?id=sonarsource-cfamily-examples_linux-autotools-gh-actions-sq_AYAYt8D0y0k_ZlpkA-ln[SonarQube Server]!* It is very easy to analyze a C, C++ and Objective-C project with SonarQube: @@ -17,17 +17,17 @@ It is very easy to analyze a C, C++ and Objective-C project with SonarQube: . Create a `sonar-project.properties` file to store your configuration . In your `.github/workflows/build.yml` file: .. Set the environment variable `SONAR_SERVER_URL` to your server url (e.g.: https://example.com:9000) -.. Download the Sonar Scanner and Build Wrapper using https://github.com/SonarSource/sonarqube-github-c-cpp[the SonarQube Scan for C and C++ Github Action] +.. Download the Build Wrapper using https://github.com/SonarSource/sonarqube-scan-action/install-build-wrapper[the Install Build Wrapper Action] .. Wrap your compilation with the Build Wrapper -.. Run `sonar-scanner` as the final step -. 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 https://docs.sonarqube.org/latest/user-guide/user-token/[Generating and Using Tokens]). +.. Run the SonarQube Scan using https://github.com/SonarSource/sonarqube-scan-action[the SonarQube Scan Action] as final step +. 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 Server (see https://docs.sonarqube.org/latest/user-guide/user-token/[Generating and Using Tokens]). You can take a look at the link:sonar-project.properties[sonar-project.properties] and link:.github/workflows/build.yml[build.yml] to see it in practice. = Documentation - https://docs.sonarqube.org/latest/analysis/languages/cfamily/[Documentation overview of the C, C++ and Objective-C analyzer] -- https://docs.sonarqube.org/latest/analysis/github-integration/[GitHub Integration in SonarQube] +- https://docs.sonarqube.org/latest/analysis/github-integration/[GitHub Integration in SonarQube Server] - https://docs.sonarqube.org/latest/analyzing-source-code/languages/c-family/prerequisites/#generating-a-compilation-database[Generating a compilation database (compile_commands.json)] - https://docs.sonarqube.org/latest/analyzing-source-code/languages/c-family/running-the-analysis/[Running the analysis in Compilation Database mode] @@ -47,7 +47,7 @@ make clean all An example of a flawed C++ code. The https://github.com/sonarsource-cfamily-examples/code[code repository] is meant to be compiled with different build systems using different CI pipelines on Linux, macOS, and Windows. The https://github.com/sonarsource-cfamily-examples/code[code repository] is forked into other repositories in https://github.com/sonarsource-cfamily-examples[this collection] to add a specific build system, platform, and CI. -The downstream repositories are analyzed either with https://www.sonarqube.org/[SonarQube] or https://sonarcloud.io/[SonarCloud]. +The downstream repositories are analyzed either with https://www.sonarqube.org/[SonarQube] or https://sonarcloud.io/[SonarQube Cloud]. You can find examples for: @@ -74,8 +74,8 @@ Running on the following CI services: Configured for analysis on: -* https://github.com/sonarsource-cfamily-examples?q=-sq[SonarQube] -* https://github.com/sonarsource-cfamily-examples?q=-sc[SonarCloud] +* https://github.com/sonarsource-cfamily-examples?q=-sq[SonarQube Server] +* https://github.com/sonarsource-cfamily-examples?q=-sc[SonarQube Cloud] You can find also a few examples demonstrating: