Sonar Scanner Action

Moved to https://github.com/philips-software/sonar-scanner-action

A GitHub action to configure and run the SonarQube scanner inside a SonarQube Docker container.

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.

Action input parameters

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

Action output parameters

Parameter	Description
sonarParameters	Sonar parameters generate based on inpu

sonarParameters: description: Sonar parameters generate based on input.

Sample Configuration

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.

Invoke the scanner without pull request decoration

sonarqube:
  name: SonarQube
  runs-on: self-hosted
  steps:
    - uses: philips-labs/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/

Invoke the scanner with pull request decoration

  name: SonarQube
  runs-on: self-hosted
  steps:
    - uses: philips-labs/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: true

Create configuration for the scanner with pull request decoration

  name: SonarQube
  runs-on: self-hosted
  steps:
    - name: Configure sonar scanner
      uses: philips-labs/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
    - name: Run sonar scanner
        uses: docker://openjdk:11.0.6-jdk-slim
        with:
          entrypoint: bash
          args:
            -c "./gradlew --info sonarQube ${{ steps.sonarconfig.outputs.sonarParameters }}"