Skip to content

Commit f87cfc4

Browse files
authored
doc: Changes made in the doc according to the newer version (#5024)
* Changes made in the doc according to the newer version * Revert "Changes made in the doc according to the newer version" This reverts commit 1f4d806. * created a doc for the newer version of the plugin * added the pass/fail condition * corrected mistakes
1 parent 890b200 commit f87cfc4

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Sonarqube v1.1.0
2+
3+
Configuring `Sonarqube-v1.1.0` in pre-build or post build task enhances your workflow with Continuous Code Quality & Code Security.
4+
5+
**Prerequisite**: Make sure you have set up an account in `Sonarqube` or get the API keys from an admin.
6+
7+
1. On the **Edit build pipeline** page, select the **Pre-Build Stage** (or Post-Build Stage).
8+
2. Click **+ Add task**.
9+
3. Select **Sonarqube v1.1.0** from **PRESET PLUGINS**.
10+
11+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/plugins/sonarqube-v1.1.0.jpeg)
12+
13+
* Enter a relevant name in the `Task name` field. It is a mandatory field.
14+
* Enter a descriptive message for the task in the `Description` field. It is an optional field.
15+
* Provide a value for the input variable.<br> Note: The value may be any of the values from the previous build stages, a global variable, or a custom value.</br>
16+
17+
| Variable | Format | Description |
18+
| ---- | ---- | ---- |
19+
| SonarqubeProjectPrefixName | String | This is the SonarQube project prefix name. If not provided, the prefix name is automatically generated. |
20+
| SonarqubeBranchName | String | Branch name to be used to send the scanned result on sonarqube project. |
21+
| SonarqubeProjectKey | String | Project key of SonarQube account |
22+
| CheckForSonarAnalysisReport | Bool | Boolean value - true or false. Set true to poll for generated report from sonarqube. |
23+
| AbortPipelineOnPolicyCheckFailed | Bool | Boolean value - true or false. Set true to abort on report check failed. |
24+
| UsePropertiesFileFromProject | Bool | Boolean value - true or false. Set true to use source code sonar-properties file. |
25+
| SonarqubeEndpoint | String | API endpoint of SonarQube account. |
26+
| CheckoutPath | String | Checkout path of Git material. |
27+
| SonarqubeApiKey | String | API key of SonarQube account |
28+
| SonarContainerImage | String | Container Image that will be used for sonar scanning purpose. |
29+
30+
* `Trigger/Skip Condition` refers to a conditional statement to execute or skip the task. You can select either:<ul><li>`Set trigger conditions` or</li><li>`Set skip conditions`</li></ul>
31+
* `Pass/Fail Condition` refers to a conditional statement to pass or fail the **Pre-Build Stage** (or Post-Build Stage). You can select either:<ul><li>`Set pass conditions` or</li><li>`Set failure conditions`</li></ul>
32+
33+
* Click **Update Pipeline**.

0 commit comments

Comments
 (0)