actions/sonarqube-scan-action
2
0
Fork 0
mirror of https://github.com/SonarSource/sonarqube-scan-action.git synced 2025-12-16 19:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Code review: improve README for use of "no Build Wrapper" vs "Build Wrapper"

Browse source
This commit is contained in:
Antonio Aversa 2024-12-12 15:01:22 +01:00
parent 8072fc8c86
commit db6f5ff14b
1 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -41,9 +41,11 @@ sonar.projectKey=<replace with the key generated when setting up the project on
sonar.sources=. sonar.sources=.
``` ```
The workflow, usually declared under `.github/workflows`, looks like the following: In the following cases:
- for projects **not** written in C, C++, and Objective-C - for projects that don't have C, C++, or Objective-C in them
- and for projects written in C, C++, and Objective-C and using [AutoConfig](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/languages/c-family/analysis-modes/#choosing-the-right-analysis-mode) - for C, C++, Objective-C projects that don't use [Build Wrapper](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/languages/c-family/prerequisites/#using-buildwrapper)
the workflow, usually declared under `.github/workflows`, looks like the following:
```yaml ```yaml
on: on:
@ -73,7 +75,7 @@ jobs:
SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }} SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }}
``` ```
For C, C++ and Objective-C projects not using AutoConfig, the workflow requires additional steps to download the Build Wrapper and invoking it: For C, C++, and Objective-C projects relying on [Build Wrapper](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/languages/c-family/prerequisites/#using-buildwrapper) to generate the compilation database, the workflow requires additional steps to download the Build Wrapper and invoke it:
```yaml ```yaml
# Trigger analysis when pushing to your main branches, and when creating a pull request. # Trigger analysis when pushing to your main branches, and when creating a pull request.
@ -118,7 +120,10 @@ jobs:
#Consult https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/scanners/sonarscanner/ for more information and options #Consult https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/scanners/sonarscanner/ for more information and options
``` ```
If you are using SonarQube Server 10.5 or earlier, use `sonar.cfamily.build-wrapper-output` instead of `sonar.cfamily.compile-commands` in the `run` property of the last step, as Build Wrapper does not generate a compile_commands.json file before SonarQube Server 10.6, like this: If you are using SonarQube Server 10.5 or earlier, use `sonar.cfamily.build-wrapper-output` instead of `sonar.cfamily.compile-commands` in the `args` property of the last step, as Build Wrapper does not generate a `compile_commands.json` file before SonarQube Server 10.6.
It should look like this:
```yaml ```yaml
with: with:
args: | args: |
@ -138,7 +143,11 @@ sonar.projectKey=<replace with the key generated when setting up the project on
sonar.sources=. sonar.sources=.
``` ```
The workflow, usually declared under `.github/workflows`, looks like: In the following cases:
- for projects that don't have C, C++, or Objective-C in them
- for C, C++, Objective-C projects that don't use [Build Wrapper](https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/languages/c-family/prerequisites/#using-build-wrapper)
the workflow, usually declared under `.github/workflows`, looks like the following:
```yaml ```yaml
on: on:
@ -167,7 +176,7 @@ jobs:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
``` ```
For C, C++ and Objective-C projects not using AutoConfig, the workflow requires additional steps to download the Build Wrapper and invoking it: For C, C++, and Objective-C projects relying on [Build Wrapper](https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/languages/c-family/prerequisites/#using-build-wrapper) to generate the compilation database, the workflow requires additional steps to download the Build Wrapper and invoke it:
```yaml ```yaml
# Trigger analysis when pushing to your main branches, and when creating a pull request. # Trigger analysis when pushing to your main branches, and when creating a pull request.