step.yml

title: "SonarQube Scanner"
summary: "Runs SonarQube Scanner CLI"
description: |-
  This step provides only a **scanner** (client) which needs SonarQube **server** to work.
  If you haven't access to server check out this tutorial: 
  [Getting Started](https://docs.sonarsource.com/sonarqube/latest/#getting-started).
  Local server can be spawned in previous script step. 
  See [test of this step](https://github.com/DroidsOnRoids/bitrise-step-sonarqube-scanner/blob/master/bitrise.yml) 
  for sample step implementation.

  Analysis result can be saved to file (specified via `sonar.report.export.path` property) or send directly by server e.g.
  to [GitHub PullRequest comment](https://docs.sonarsource.com/sonarqube/latest/devops-platform-integration/github-integration/).
  
  Scanner properties can be provided via `sonar-project.properties` file in the workspace root directory or typed in input below.
  See [SonarQube Scanner documentation](https://docs.sonarsource.com/sonarqube/latest/analyzing-source-code/scanners/sonarscanner/) 
  for more details.
  
  If both file and properties are specified, they will be merged by appending properties to the file.
  
website: https://github.com/DroidsOnRoids/bitrise-step-sonarqube-scanner
source_code_url: https://github.com/DroidsOnRoids/bitrise-step-sonarqube-scanner
support_url: https://github.com/DroidsOnRoids/bitrise-step-sonarqube-scanner/issues
type_tags:
- utility
deps:
  apt_get:
  - name: unzip
  - name: wget
  - name: curl
  brew:
  - name: unzip
  - name: wget
  - name: curl
is_requires_admin_user: false
is_always_run: false
is_skippable: false
inputs:
- scanner_version: 4.6.2.2472
  opts:
    title: Scanner CLI version
    description: |-
      Scanner CLI version to be used. Step will fail if invalid or non-existent is specified.

      `latest` can be used to use the latest available scanner
    is_required: true
- scanner_properties:
  opts:
    title: Scanner parameters in Java properties format
    description: |-
      See [analysis parameters](https://docs.sonarqube.org/display/SONAR/Analysis+Parameters) documentation
      for list of possible options.
      
      Example:
      ```
      sonar.sources=.
      sonar.java.binaries=build/classes/kotlin/main
      sonar.login=TOKEN_HERE
      #environment variables are evaluated
      sonar.projectKey=$BITRISE_APP_TITLE
      sonar.host.url=https://sonar.example.test
      sonar.report.export.path=sonar-report.json
      ```

    is_required: false
    is_expand: true
- is_debug: "false"
  opts:
    title: Print all executed shell commands to a build log?
    description: |-
      Whether trace of shell commands should be printed to a build log.
      In addition, debug logging will be enabled for SonarQube (by adding the -X argument).
      
      Options:
      * "true"
      * "false" (default)
    is_expand: false
    value_options: ["true", "false"]
run_if: ""