A GitHub action to configure and run the SonarQube scanner inside a SonarQube Docker container and connect to a self hosted Sonar.
The action support the following features
- Configure scanner
- Configure scanner for pull request decoration
- Run sonar scanner
- Export scanner configuration for consuming by e.g.
gradle,maven.
| Parameter | Description | required | default |
|---|---|---|---|
| projectName | Your application's name in SonarQube | yes | |
| projectKey | Unique value for your project in SonarQube | yes | |
| baseDir | Relative path to your sonar.properties file (default: .) |
no | . |
| token | SonarQube login token | yes | |
| url | SonarQube server url | yes | |
| scmProvider | SCM provider | no | git |
| sourceEncoding | Encoding of the source files | no | UTF-8 |
| enablePullRequestDecoration | Decorate a pull request. PR, branch and base are extracted from the pull | no | false |
| onlyConfig | "Generate sonar configuration, scanner will not be invoked. Sonar parameters are available as output. | no | false |
| isCommunityEdition | Flag your SonarQube instance as Community edition. Disables PRs/branches and defaults branch to master | no | false |
| Parameter | Description |
|---|---|
| sonarParameters | Sonar parameters generate based on input |
To prevent your token from showing in the runner's output, it is advised to store the token configuration inside of a github secret variable.
The listing below uses the secret SONARQUBE_TOKEN from your project's configuration.
sonarqube:
name: SonarQube
runs-on: self-hosted
steps:
- uses: philips-software/sonar-scanner-action@<version>
with:
token: ${{ secrets.SONARQUBE_TOKEN }}
projectName: My Project Name
projectKey: project.key.from.sonar.qube
baseDir: .
url: https://your.sonar.instance.io/name: SonarQube
runs-on: self-hosted
steps:
- uses: philips-software/sonar-scanner-action@<version>
with:
token: ${{ secrets.SONARQUBE_TOKEN }}
projectName: My Project Name
projectKey: project.key.from.sonar.qube
url: https://your.sonar.instance.io/
enablePullRequestDecoration: truesonarqube:
name: SonarQube
runs-on: self-hosted
steps:
- uses: philips-software/sonar-scanner-action@<version>
with:
token: ${{ secrets.SONARQUBE_TOKEN }}
projectName: My Project Name
projectKey: project.key.from.sonar.qube
url: https://your.sonar.instance.io/
isCommunityEdition: true name: SonarQube
runs-on: self-hosted
steps:
- name: Configure sonar scanner
uses: philips-software/sonar-scanner-action@<version>
id: sonarconfig
with:
token: ${{ secrets.SONARQUBE_TOKEN }}
projectName: My Project Name
projectKey: project.key.from.sonar.qube
url: https://your.sonar.instance.io/
enablePullRequestDecoration: true
onlyConfig: true
- name: Run sonar scanner
uses: docker://openjdk:11.0.6-jdk-slim
with:
entrypoint: bash
args:
-c "./gradlew --info sonarQube ${{ steps.sonarconfig.outputs.sonarParameters }}"
This module is part of the Philips Forest.
___ _
/ __\__ _ __ ___ ___| |_
/ _\/ _ \| '__/ _ \/ __| __|
/ / | (_) | | | __/\__ \ |_
\/ \___/|_| \___||___/\__|
CI
Talk to the forestkeepers in the forest-channel on Slack.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent