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 | ||
|---|---|---|
| ||
There are 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 Name | Property Code | Required | Description | 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 Username | FDSONARQUBEACCT_USERNAME | No | The username for your SonarQube Server Instance. Provide a token or username and password. | ||||
| SonarQube Password | FDSONARQUBEACCT_PASSWORD | No | The password for your SonarQube Server Instance. Provide a token or username and password. |
Environment/Instance Properties
...
| Property Name | Property Code | Required | Description | SonarQube Project Key | FDSQ_PROJECT_KEY | Yes | Unique identifier for a given SonarQube instance project.
|---|
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| FDSQ_INP_ANALYSIS_TOOL_ACCOUNT_CODE | Yes | The SonarQube account with all the required properties like Sonar Scanner Home, Instance Url, Token for running SonarQube Instance. | |
| Sonar Project Properties Path | FDSQ_INP_PROPERTIES_FILE_PATH | No | Absolute file path of the sonar-project.properties file. |
| Analysis Properties | FDSQ_INP_ANALYSIS_PROPERTIES | No | Define the sonar project properties manually. This will override all other fields. Required property: sonar.projectKey |
...
| Output Name | Description |
|---|---|
| Id of the task or Sonar scan started. | |
| FDSQ_OUT_DASHBOARD_URL | SonarQube 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.
...
- Under SonarQube Account define: The bin folder location of your sonar scanner on your environment.
- SonarQube Instance URL (http://host:port with no extra "/" at the end).
- Token OR username AND password for SonarQube Instance.
...