SQCPPGHA-14 Deprecate in favor of sonarqube-scan-action

SonarSource · Dec 24, 2024 · da148e7 · da148e7
1 parent f415b51
commit da148e7
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,23 @@
 # Scan your C, C++, and Objective-C code with SonarQube Server [![Tests](https://github.com/SonarSource/sonarqube-github-c-cpp/actions/workflows/tests.yml/badge.svg)](https://github.com/SonarSource/sonarqube-github-c-cpp/actions/workflows/tests.yml)
 
+> [!WARNING]
+> This action is deprecated and will be removed in a future release.
+>
+> Please use the `sonarqube-scan-action` and its `install-build-wrapper` sub-action instead.
+>
+> More specifically, if the action is used to install both the SonarScanner CLI and the Build Wrapper:
+> - replace `sonarqube-github-c-cpp` with the latest version of `SonarSource/sonarqube-scan-action/install-build-wrapper`
+> - if the step calling the action is named `Install sonar-scanner and build-wrapper`, or something similar, rename it to `Install Build Wrapper`
+> - replace the step calling `sonar-scanner` with a step using `SonarSource/sonarqube-scan-action`
+> - the arguments passed to `sonar-scanner` should be passed to the action via the `args` input parameter
+>
+> If the action is used to install the SonarScanner CLI, and the Build Wrapper is not required:
+> - remove the `sonarqube-github-c-cpp` step altogether
+> - replace the step calling `sonar-scanner` with a step using `SonarSource/sonarqube-scan-action`
+> - the arguments passed to `sonar-scanner` should be passed to the action via the `args` input parameter
+>
+> Check the C++ section in [the README of the `sonarqube-scan-action`](https://github.com/SonarSource/sonarqube-scan-action/?tab=readme-ov-file#server-1) for complete examples.
+
 This SonarSource project, available as a GitHub Action, scans your C, C++, and Objective-C projects with [SonarQube Server](https://www.sonarsource.com/products/sonarqube/).
 
 ![Logo](./images/SQ_Logo_Cloud_Dark_Backgrounds.png#gh-dark-mode-only)

diff --git a/action.yml b/action.yml
@@ -24,6 +24,10 @@ outputs:
 runs:
   using: "composite"
   steps:
+    - name: Deprecation warning
+      shell: bash
+      run: |
+        echo "::warning title=SonarScanner::This action is deprecated and will be removed in a future release. Please use the sonarqube-scan-action and its install-build-wrapper sub-action instead."
     - name: SonarQube Scan
       id: scan
       uses: sonarsource/sonarqube-scan-action/deprecated-c-cpp@v4.2.1