Skip to content

Commit 7a4ef89

Browse files
committed
SCCPPGHA-16 Deprecate in favor of sonarqube-scan-action
1 parent 166e6d6 commit 7a4ef89

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# 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)
22

3+
> [!WARNING]
4+
> This action is deprecated and will be removed in a future release.
5+
>
6+
> Please use the `sonarqube-scan-action` and its `install-build-wrapper` sub-action instead.
7+
>
8+
> More specifically, if the action is used to install both the SonarScanner CLI and the Build Wrapper:
9+
> - replace `sonarcloud-github-c-cpp` with the latest version of `SonarSource/sonarqube-scan-action/install-build-wrapper`
10+
> - if the step calling the action is named `Install sonar-scanner and build-wrapper`, or something similar, rename it to `Install Build Wrapper`
11+
> - replace the step calling `sonar-scanner` with a step using `SonarSource/sonarqube-scan-action`
12+
> - the arguments passed to `sonar-scanner` should be passed to the action via the `args` input parameter
13+
>
14+
> If the action is used to install the SonarScanner CLI, and the Build Wrapper is not required:
15+
> - remove the `sonarcloud-github-c-cpp` step altogether
16+
> - replace the step calling `sonar-scanner` with a step using `SonarSource/sonarqube-scan-action`
17+
> - the arguments passed to `sonar-scanner` should be passed to the action via the `args` input parameter
18+
>
19+
> 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.
20+
321
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/).
422

523
![Logo](./images/SQ_Logo_Cloud_Dark_Backgrounds.png#gh-dark-mode-only)

action.yml

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ outputs:
2626
runs:
2727
using: "composite"
2828
steps:
29+
- name: Deprecation warning
30+
shell: bash
31+
run: |
32+
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."
2933
- name: SonarQube Cloud Scan
3034
id: scan
3135
uses: sonarsource/sonarqube-github-c-cpp@25a2efe466506d2293f19f2e3062df4247477464

0 commit comments

Comments
 (0)