diff --git a/README.md b/README.md index 5f1ff84..d7390ca 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ # Scan your C, C++, and Objective-C code with SonarQube Cloud [![QA](https://github.com/SonarSource/sonarcloud-github-c-cpp/actions/workflows/qa.yml/badge.svg)](https://github.com/SonarSource/sonarcloud-github-c-cpp/actions/workflows/qa.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 `sonarcloud-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 `sonarcloud-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#cloud-1) for complete examples. + This SonarSource project, available as a GitHub Action, scans your C, C++, and Objective-C projects with SonarQube [Cloud](https://www.sonarsource.com/products/sonarcloud/). ![Logo](./images/SQ_Logo_Cloud_Dark_Backgrounds.png#gh-dark-mode-only) diff --git a/action.yml b/action.yml index c11d5a7..e5095e6 100644 --- a/action.yml +++ b/action.yml @@ -26,6 +26,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 Cloud Scan id: scan uses: sonarsource/sonarqube-github-c-cpp@25a2efe466506d2293f19f2e3062df4247477464