SQCPPGHA-9 Rebrand and forward to sonarqube-scan-action/deprecated-c-cpp-action

README.md

@@ -1,45 +1,46 @@
-# Configure & Run C, C++ and Objective-C Scan with SonarQube [![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)
+# Scan your C, C++, and Objective-C code with SonarQube [![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)
 
-This SonarSource project, available as a GitHub Action, sets up the tools needed to configure and run scans of C, C++, and Objective-C projects with SonarQube.
+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/).
 
-<img alt="The SonarQube logo" src="./images/SonarQube-72px.png">
+![Logo](./images/SQ_Logo_Cloud_Dark_Backgrounds.png#gh-dark-mode-only)
+![Logo](./images/SQ_Logo_Cloud_Light_Backgrounds.png#gh-light-mode-only)
 
-[SonarQube](https://www.sonarsource.com/products/sonarqube/) is a widely used static analysis solution for continuous code quality and security inspection. 
-It helps developers identify and fix issues in their code that could lead to bugs, vulnerabilities, or decreased development velocity.
-SonarQube supports the most popular programming languages, including Java, JavaScript, TypeScript, C#, Python, C, C++, and [many more](https://www.sonarsource.com/knowledge/languages/).
+[SonarQube Server](https://www.sonarsource.com/products/sonarqube/) is a widely used static analysis solution for continuous code quality and security inspection.
 
-## Requirements
+It helps developers detect coding issues in 30+ languages, frameworks, and IaC platforms, including Java, JavaScript, TypeScript, C#, Python, C, C++, and [many more](https://www.sonarsource.com/knowledge/languages/).
 
-To run an analysis on your code, you first need to set up your project on SonarQube. 
-Your SonarQube instance must be accessible from GitHub, and you will need a Project analysis token or a Global analysis token to run the analysis (more information below under **Environment variables**).
+The solution also provides fix recommendations leveraging AI with Sonar's AI CodeFix capability.
 
-Read more information on how to analyze your code [here](https://docs.sonarqube.org/latest/analysis/github-integration/).
+## Requirements
 
+To run an analysis on your code, you first need to set up your project on SonarQube Server. Your SonarQube Server instance must be accessible from GitHub, and you will need an access token to run the analysis (more information below under **Environment variables**).
 
-## Usage
+Read more information on how to analyze your code [here](https://docs.sonarsource.com/sonarqube-server/latest/devops-platform-integration/github-integration/introduction/).
 
-
-Project metadata, including the location to the sources to be analyzed, must be declared in the file `sonar-project.properties` in the base directory:
+## Usage
 
 ```properties
-sonar.projectKey=<replace with the key generated when setting up the project on SonarQube>
+sonar.projectKey=<replace with the key generated when setting up the project on SonarQube Server>
 
 # relative paths to source directories. More details and properties are described
-# in https://docs.sonarsource.com/sonarqube/latest/project-administration/analysis-scope/
+# at https://docs.sonarsource.com/sonarqube-server/latest/project-administration/analysis-scope/ 
 sonar.sources=.
 ```
 
-The workflow, usually declared in `.github/workflows/build.yml`, looks like:
+The workflow, usually declared under `.github/workflows`, looks like the following:
 
 ```yaml
 on:
-  # Trigger analysis when pushing in master or pull requests, and when creating
-  # a pull request.
+  # Trigger analysis when pushing to your main branches, and when creating a pull request.
   push:
     branches:
+      - main
       - master
+      - develop
+      - 'releases/**'
   pull_request:
       types: [opened, synchronize, reopened]
+
 name: Main Workflow
 jobs:
   sonarqube:
@@ -52,79 +53,84 @@ jobs:
         # Disabling shallow clone is recommended for improving relevancy of reporting
         fetch-depth: 0
     - name: Install sonar-scanner and build-wrapper
-      uses: sonarsource/sonarqube-github-c-cpp@v2
-      env:
-        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
-        SONAR_ROOT_CERT: ${{ secrets.SONAR_ROOT_CERT }}
+      uses: sonarsource/sonarqube-github-c-cpp@<action version> # Ex: v4.0.0, See the latest version at https://github.com/marketplace/actions/sonarqube-scan-for-c-and-c
     - 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
-      # build-preparation steps
-      # build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} build-command
+        # here goes your compilation wrapped with build-wrapper; See https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/languages/c-family/overview/#analysis-steps-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
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
       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:
+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:
 ```yaml
-      run: sonar-scanner --define sonar.cfamily.build-wrapper-output="${{ env.BUILD_WRAPPER_OUT_DIR }}"
+run: sonar-scanner --define sonar.cfamily.compile-commands="${{ env.BUILD_WRAPPER_OUT_DIR }}/compile_commands.json"
 ```
 
+See also [example configurations of C++ projects for SonarQube Server](https://github.com/search?q=org%3Asonarsource-cfamily-examples+gh-actions-sq&type=repositories).
+
+## Action parameters
 
 You can change the `build-wrapper` and `sonar-scanner` installation path by using the optional input `installation-path` like this:
 
 ```yaml
-uses: sonarsource/sonarqube-github-c-cpp@v2
+uses: sonarsource/sonarqube-github-c-cpp@<action version>
 with:
   installation-path: my/custom/directory/path
 ```
+
 Also, the absolute paths to the installed build-wrapper and sonar-scanner binaries are returned as outputs from the action.
 
 Moreover, by default the action will cache sonar-scanner installation. However, you can disable caching by using the optional input: `cache-binaries` like this:
 ```yaml
-uses: sonarsource/sonarqube-github-c-cpp@v2
+uses: sonarsource/sonarqube-github-c-cpp@<action version>
 with:
   cache-binaries: false
 ```
 
-If your SonarQube server uses a self-signed certificate, you can pass a root certificate (in PEM format) to the java certificate store:
+See also [example configurations](https://github.com/sonarsource-cfamily-examples?q=gh-actions-sq&type=all&language=&sort=)
 
-```yaml
-uses: sonarsource/sonarqube-github-c-cpp@v2
-env:
-  SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-  SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
-  SONAR_ROOT_CERT: ${{ secrets.SONAR_ROOT_CERT }}
-```
+### Environment variables
 
-See also [example configurations](https://github.com/search?q=org%3Asonarsource-cfamily-examples+gh-actions-sq&type=repositories)
+- `SONAR_TOKEN` – **Required** this is the token used to authenticate access to SonarQube. You can read more about security tokens in the [documentation](https://docs.sonarsource.com/sonarqube-server/latest/user-guide/managing-tokens/). You can set the `SONAR_TOKEN` environment variable in the "Secrets" settings page of your repository, or you can add them at the level of your GitHub organization (recommended).
+- *`GITHUB_TOKEN` – Provided by Github (see [Authenticating with the GITHUB_TOKEN](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)).*
+- `SONAR_HOST_URL` – this tells the scanner where SonarQube Server is hosted. You can set the `SONAR_HOST_URL` environment variable in the "Variables" settings page of your repository, or you can add them at the level of your GitHub organization (recommended).
+- `SONAR_ROOT_CERT` – Holds an additional certificate (in PEM format) that is used to validate the certificate of SonarQube Server or of a secured proxy to it. You can set the `SONAR_ROOT_CERT` environment variable in the "Secrets" settings page of your repository, or you can add them at the level of your GitHub organization (recommended).
 
-### Secrets and environment variables
+Here is an example of how you can pass a certificate (in PEM format) to the Scanner truststore:
 
-Following secrets are required for successful invocation of sonar-scanner: 
-- `SONAR_TOKEN` – **Required** this is the token used to authenticate access to SonarQube. You can read more about security tokens [here](https://docs.sonarqube.org/latest/user-guide/user-token/). You can set the `SONAR_TOKEN` environment variable in the "Secrets" settings page of your repository, or you can add them at the level of your GitHub organization (recommended).
-- *`GITHUB_TOKEN` – Provided by Github (see [Authenticating with the GITHUB_TOKEN](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)).*
+```yaml
+- uses: sonarsource/sonarqube-github-c-cpp@<action version>
+  env:
+    SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+    SONAR_ROOT_CERT: ${{ secrets.SONAR_ROOT_CERT }}
+```
+
+If your source code file names contain special characters that are not covered by the locale range of `en_US.UTF-8`, you can configure your desired locale like this:
 
-Environment variables:
-- `SONAR_HOST_URL` – **Required** this tells the scanner where SonarQube is hosted. You can set the `SONAR_HOST_URL` environment variable in the "Secrets" settings page of your repository, or you can add them at the level of your GitHub organization (recommended).
-- `SONAR_ROOT_CERT` – Holds an additional root certificate (in PEM format) that is used to validate the SonarQube server certificate. You can set the `SONAR_ROOT_CERT` environment variable in the "Secrets" settings page of your repository, or you can add them at the level of your GitHub organization (recommended).
+```yaml
+- uses: sonarsource/sonarqube-github-c-cpp@<action version>
+  env:
+    SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+    LC_ALL: "ru_RU.UTF-8"
+```
 
 ## Do not use this GitHub action if you are in the following situations
 
-* You want to analyze code that doesn't have C, C++, or Objective-C? Use the [SonarQube Scan GitHub Action](https://github.com/SonarSource/sonarqube-scan-action) instead
-* You want to run the action on a 32-bits system - build wrappers support only 64-bits OS
+* You want to analyze code written in a language other than C or C++. Use the [SonarQube GitHub Action for SonarQube Server and Cloud](https://github.com/SonarSource/sonarqube-scan-action/) instead.
+* You want to run the action on a 32-bits system - build wrappers support only 64-bits OS.
 
 ## Additional information
 
-This action installs `coreutils` if run on macOS
+This action installs `coreutils` if run on macOS.
 
 ## Have question or feedback?
 
-To provide feedback (requesting a feature or reporting a bug) please post on the [SonarSource Community Forum](https://community.sonarsource.com/) with the tag `sonarqube`.
+To provide feedback (requesting a feature or reporting a bug) please post on the [SonarSource Community Forum](https://community.sonarsource.com/tags/c/help/sq/github-actions).
 
 ## License
 

action.yml

@@ -24,104 +24,23 @@ outputs:
 runs:
   using: "composite"
   steps:
-    # install packaged required for greadlink and sha256sum command on macOS
-    - name: Install required packages for macOS
-      if: runner.os == 'macOS'
-      shell: bash
-      run: brew install coreutils
-
-    - name: Verify and create installation path
-      shell: bash
-      env:
-        INSTALL_PATH: ${{ inputs.installation-path }}
-      run: ${GITHUB_ACTION_PATH}/scripts/create_install_path.sh
-
-    - name: Set version of sonar-scanner
-      id: sonar-scanner-version
-      shell: bash
-      run: cat ${GITHUB_ACTION_PATH}/sonar-scanner-version >> $GITHUB_OUTPUT
-
-    - name: Configure paths
-      id: configure_paths
-      shell: bash
-      env:
-        OS: ${{ runner.os }}
-        ARCH: ${{ runner.arch }}
-        INSTALL_PATH: ${{ inputs.installation-path }}
-        SONAR_SCANNER_VERSION: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-version }}
-        SONAR_SCANNER_URL_WINDOWS_X64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-url-windows-x64 }}
-        SONAR_SCANNER_SHA_WINDOWS_X64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-sha-windows-x64 }}
-        SONAR_SCANNER_URL_LINUX_X64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-url-linux-x64 }}
-        SONAR_SCANNER_SHA_LINUX_X64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-sha-linux-x64 }}
-        SONAR_SCANNER_URL_LINUX_AARCH64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-url-linux-aarch64 }}
-        SONAR_SCANNER_SHA_LINUX_AARCH64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-sha-linux-aarch64 }}
-        SONAR_SCANNER_URL_MACOSX_X64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-url-macosx-x64 }}
-        SONAR_SCANNER_SHA_MACOSX_X64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-sha-macosx-x64 }}
-        SONAR_SCANNER_URL_MACOSX_AARCH64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-url-macosx-aarch64 }}
-        SONAR_SCANNER_SHA_MACOSX_AARCH64: ${{ steps.sonar-scanner-version.outputs.sonar-scanner-sha-macosx-aarch64 }}
-      run: ${GITHUB_ACTION_PATH}/scripts/configure_paths.sh >> $GITHUB_OUTPUT
-
-    - name: Cache sonar-scanner installation
-      id: cache-sonar-tools
-      if: inputs.cache-binaries == 'true'
-      uses: actions/cache@v4
-      env:
-        # The default value is 60mins. Reaching timeout is treated the same as a cache miss.
-        SEGMENT_DOWNLOAD_TIMEOUT_MINS: 1
+    - name: SonarQube Scan
+      id: scan
+      uses: sonarsource/sonarqube-scan-action/deprecated-c-cpp@antonio/SQCPPGHA-9-rebranding-and-forward
       with:
-        key: sonar-scanner-${{ runner.os }}-${{ runner.arch }}-${{ steps.sonar-scanner-version.outputs.sonar-scanner-version }}
-        path: ${{ steps.configure_paths.outputs.sonar-scanner-dir }}
-
-    - name: Download and install sonar-scanner
-      if: steps.cache-sonar-tools.outputs.cache-hit != 'true'
-      shell: bash
-      env:
-        DOWNLOAD_URL: ${{ steps.configure_paths.outputs.sonar-scanner-url }}
-        EXPECTED_SHA: ${{ steps.configure_paths.outputs.sonar-scanner-sha }}
-        INSTALL_PATH: ${{ inputs.installation-path }}
-        TMP_ZIP_PATH: ${{ runner.temp }}/sonar-scanner.zip
-      run: ${GITHUB_ACTION_PATH}/scripts/download.sh -v
-
-    - name: Add the custom root certificate to java certificate store
-      shell: bash
-      run: ${GITHUB_ACTION_PATH}/scripts/cert.sh
-
-    - name: Download and install build-wrapper
-      shell: bash
-      env:
-        DOWNLOAD_URL: ${{ steps.configure_paths.outputs.build-wrapper-url }}
-        INSTALL_PATH: ${{ inputs.installation-path }}
-        TMP_ZIP_PATH: ${{ runner.temp }}/build-wrapper.zip
-      run: ${GITHUB_ACTION_PATH}/scripts/download.sh
-
+        installation-path: ${{ inputs.installation-path }}
+        cache-binaries: ${{ inputs.cache-binaries }}
     - name: Setup action outputs
       id: setup-outputs
       shell: bash
       env:
-        SONAR_SCANNER_DIR: ${{ steps.configure_paths.outputs.sonar-scanner-dir }}
-        SONAR_SCANNER_BIN: ${{ steps.configure_paths.outputs.sonar-scanner-bin }}
-        BUILD_WRAPPER_DIR: ${{ steps.configure_paths.outputs.build-wrapper-dir }}
-        BUILD_WRAPPER_BIN: ${{ steps.configure_paths.outputs.build-wrapper-bin }}
+        SONAR_SCANNER_BINARY: ${{ steps.scan.outputs.sonar-scanner-binary }}
+        BUILD_WRAPPER_BINARY: ${{ steps.scan.outputs.build-wrapper-binary }}
       run: |
-        source ${GITHUB_ACTION_PATH}/scripts/utils.sh
-
         echo "::group::Action outputs"
-        echo "SONAR_HOST_URL=${SONAR_HOST_URL}" >> $GITHUB_ENV
-        echo "'SONAR_HOST_URL' environment variable set to '${SONAR_HOST_URL}'"
-
-        SONAR_SCANNER_BIN_DIR=$(realpath "${SONAR_SCANNER_DIR}/bin")
-        echo "${SONAR_SCANNER_BIN_DIR}" >> $GITHUB_PATH
-        echo "'${SONAR_SCANNER_BIN_DIR}' added to the path"
-
-        SONAR_SCANNER_BIN=$(realpath "${SONAR_SCANNER_BIN}")
-        echo "sonar-scanner-binary=${SONAR_SCANNER_BIN}" >> $GITHUB_OUTPUT
-        echo "'sonar-scanner-binary' output set to '${SONAR_SCANNER_BIN}'"
-
-        BUILD_WRAPPER_BIN_DIR=$(realpath "${BUILD_WRAPPER_DIR}")
-        echo "${BUILD_WRAPPER_BIN_DIR}" >> $GITHUB_PATH
-        echo "'${BUILD_WRAPPER_BIN_DIR}' added to the path"
+        echo "sonar-scanner-binary=${SONAR_SCANNER_BINARY}" >> $GITHUB_OUTPUT
+        echo "'sonar-scanner-binary' output set to '${SONAR_SCANNER_BINARY}'"
 
-        BUILD_WRAPPER_BIN=$(realpath "${BUILD_WRAPPER_BIN}")
-        echo "build-wrapper-binary=${BUILD_WRAPPER_BIN}" >> $GITHUB_OUTPUT
-        echo "'build-wrapper-binary' output set to '${BUILD_WRAPPER_BIN}'"
+        echo "build-wrapper-binary=${BUILD_WRAPPER_BINARY}" >> $GITHUB_OUTPUT
+        echo "'build-wrapper-binary' output set to '${BUILD_WRAPPER_BINARY}'"
         echo "::endgroup::"