step.yml

#
# A couple of useful guides & docs:
#
# - Main Bitrise CLI docs: https://github.com/bitrise-io/bitrise/tree/master/_docs
# - Step Development Guideline: https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
# - Bitrise.yml format spec: https://github.com/bitrise-io/bitrise/blob/master/_docs/bitrise-yml-format-spec.md
# - Bitrise docs: http://devcenter.bitrise.io/
# - Bitrise CLI guides: http://devcenter.bitrise.io/bitrise-cli/

title: |-
  MSBuild SonarScanner (End)
summary: |
  Step for running SonarScanner agains .NET (Xamarin) projects. This the the last step from two.
description: |
  This step runs MSBuild SonarScanner. The scanner for dotnet consists of two steps. 
  This is the last step that executes `end` CLI command. 
  In between of `begin` and `end` steps the build, test run and code coverage should happen.
  
  Check official documentation [SonarScanner for MSBuild](https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-msbuild/)
  to understand how the scan process happens for dotnet.

  This step finishes the execution. The main setup happens in the [Begin Step](https://github.com/Diversido/bitrise-step-msbuild-sonarscanner-begin)

  This step will be skipped in case `$SONAR_SCANNER_FILE_PATH` environment variable is not defined.
website: https://github.com/Diversido/bitrise-step-msbuild-sonarscanner-end
source_code_url: https://github.com/Diversido/bitrise-step-msbuild-sonarscanner-end
support_url: https://github.com/Diversido/bitrise-step-msbuild-sonarscanner-end/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04

project_type_tags:
  - xamarin

# Type tags are used for categorizing steps, for easier step discovery in Step Libraries.
# You can find more information about type tags in the Step Development Guideline:
# https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md
type_tags:
  - utility

is_requires_admin_user: true
is_always_run: false
is_skippable: false
run_if: '{{getenv "SONAR_SCANNER_FILE_PATH" | ne ""}}'


toolkit:
  bash:
    entry_file: step.sh


inputs:
  - sonar_login: $SONAR_LOGIN
    opts:
      title: Username or access token to authenticate with to SonarQube
      description: |-
        This will be the value of `sonar.login`
      is_sensitive: true
      is_required: true

  - sonarscanner_file_path: $SONAR_SCANNER_FILE_PATH
    opts:
      category: "Config"
      title: A file path to `SonarScanner.MSBuild.exe`
      description: |-
        SonarScanner should've been prepared in the [MSBuild SonarScanner (Begin)](https://github.com/Diversido/bitrise-step-msbuild-sonarscanner-begin) step.
        `$SONAR_SCANNER_FILE_PATH` is generated by the Begin step.
        This property doesn't require a manual change.
      is_required: true
      is_dont_change_value: true

  # Debug
  - is_debug: "false"
    opts:
      category: "Debug"
      title: Print all executed shell commands to a build log?
      description: |-
        Whether trace of shell commands should be printd to a build log.
        Options:
        * "true"
        * "false" (default)
      is_expand: false
      value_options: ["true", "false"]