From c757f6fe25e085ed725dbd12868ad9f387d8de1a Mon Sep 17 00:00:00 2001
From: Vincenzo Pellegrini <vincenzo.pellegrini@sonarsource.com>
Date: Fri, 3 May 2024 18:57:32 +0200
Subject: [PATCH] CPP-5241 Migrate github action from build-wrapper-output to
 compilation-database

---
 README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index abe7a43..22ae88c 100644
--- a/README.md
+++ b/README.md
@@ -59,7 +59,7 @@ jobs:
         SONAR_ROOT_CERT: ${{ secrets.SONAR_ROOT_CERT }}
     - name: Run build-wrapper
       run: |
-      #here goes your compilation wrapped with build-wrapper; See https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/languages/c-family/#using-build-wrapper for more information
+      # here goes your compilation wrapped with build-wrapper; See https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/languages/c-family/#using-build-wrapper for more information
       # build-preparation steps
       # build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} build-command
     - name: Run sonar-scanner
@@ -67,9 +67,15 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
         SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
-      run: sonar-scanner --define sonar.cfamily.build-wrapper-output="${{ env.BUILD_WRAPPER_OUT_DIR }}" #Consult https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/scanners/sonarscanner/ for more information and options
+      run: sonar-scanner --define sonar.cfamily.compile-commands="${{ env.BUILD_WRAPPER_OUT_DIR }}/compile_commands.json" #Consult https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/scanners/sonarscanner/ for more information and options
 ```
 
+If you are using SonarQube 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 10.6, like this:
+```yaml
+      run: sonar-scanner --define sonar.cfamily.build-wrapper-output="${{ env.BUILD_WRAPPER_OUT_DIR }}"
+```
+
+
 You can change the `build-wrapper` and `sonar-scanner` installation path by using the optional input `installation-path` like this:
 
 ```yaml