Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Executes a sonar scan. This operation takes inputs for both a Sonar project properties path and an analysis properties file. If both are provided, the plugin will use the analysis properties and do nothing with the path. This operation only returns its task Id and browsable url on the specified SonarQube instance.

Info
titleAnalysis Properties

There are plethora a significant amount of analysis parameters available to augment a Sonar scan. It is recommended to research which parameters are necessary for your projects and sonar scans.

Analysis Tool Instance Properties

Property NameProperty CodeRequiredDescription
SonarQube Scanner Home

FDSONARQUBEACCT_SCANNER_HOME

Yes

SonarQube Scanner Home Directory

SonarQube instance URL

FDSONARQUBEACCT_INSTANCE_URL

Yes

SonarQube Server Instance URL (example: https://localhost:9000)

SonarQube Token

FDSONARQUBEACCT_TOKEN

No

SonarQube Server Token provides credentials to run code scans or to invoke web services as a replacement of the user login. Provide a token or username and password.

SonarQube UsernameFDSONARQUBEACCT_USERNAMENoThe username for your SonarQube Server Instance. Provide a token or username and password.
SonarQube PasswordFDSONARQUBEACCT_PASSWORDNoThe password for your SonarQube Server Instance. Provide a token or username and password.

Environment/Instance Properties

...

Property NameProperty CodeRequiredDescription

SonarQube Project Key

FDSQ_PROJECT_KEY

Yes

Unique identifier for a given SonarQube instance project.

Inputs

Input NameInput CodeRequiredDescription
FDSQ_INP_ANALYSIS_TOOL_ACCOUNT_CODEYesThe SonarQube account with all the required properties like Sonar Scanner Home, Instance Url, Token for running SonarQube Instance.
Sonar Project Properties PathFDSQ_INP_PROPERTIES_FILE_PATHNoAbsolute file path of the sonar-project.properties file.
Analysis PropertiesFDSQ_INP_ANALYSIS_PROPERTIESNoDefine the sonar project properties manually. This will override all other fields. Required property: sonar.projectKey

...

Output NameDescription
Id of the task or Sonar scan started.
FDSQ_OUT_DASHBOARD_URLSonarQube instance dashboard url. Note that you will be able to access the updated dashboard once the server has processed the submitted analysis report.

Artifacts

This operation doesn’t consume or produce any artifacts.

...