-
Notifications
You must be signed in to change notification settings - Fork 554
doc: Changes made in the doc according to the newer version #5024
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1f4d806
Changes made in the doc according to the newer version
SATYAsasini 65081e5
Revert "Changes made in the doc according to the newer version"
SATYAsasini 85e93fb
created a doc for the newer version of the plugin
SATYAsasini 7f5ada1
added the pass/fail condition
SATYAsasini 48c6b6b
corrected mistakes
SATYAsasini 06d3085
Merge branch 'main' into sonarqubeDoc
SATYAsasini File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Sonarqube v1.1.0 | ||
|
|
||
| Configuring `Sonarqube-v1.1.0` in pre-build or post build task enhances your workflow with Continuous Code Quality & Code Security. | ||
|
|
||
| **Prerequisite**: Make sure you have set up an account in `Sonarqube` or get the API keys from an admin. | ||
|
|
||
| 1. On the **Edit build pipeline** page, select the **Pre-Build Stage** (or Post-Build Stage). | ||
| 2. Click **+ Add task**. | ||
| 3. Select **Sonarqube v1.1.0** from **PRESET PLUGINS**. | ||
|
|
||
|  | ||
|
|
||
| * Enter a relevant name in the `Task name` field. It is a mandatory field. | ||
| * Enter a descriptive message for the task in the `Description` field. It is an optional field. | ||
| * 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> | ||
|
|
||
| | Variable | Format | Description | | ||
| | ---- | ---- | ---- | | ||
| | SonarqubeProjectPrefixName | String | This is the SonarQube project prefix name. If not provided, the prefix name is automatically generated. | | ||
| | SonarqubeBranchName | String | Branch name to be used to send the scanned result on sonarqube project. | | ||
| | SonarqubeProjectKey | String | Project key of SonarQube account | | ||
| | CheckForSonarAnalysisReport | Bool | Boolean value - true or false. Set true to poll for generated report from sonarqube. | | ||
| | AbortPipelineOnPolicyCheckFailed | Bool | Boolean value - true or false. Set true to abort on report check failed. | | ||
| | UsePropertiesFileFromProject | Bool | Boolean value - true or false. Set true to use source code sonar-properties file. | | ||
| | SonarqubeEndpoint | String | API endpoint of SonarQube account. | | ||
| | CheckoutPath | String | Checkout path of Git material. | | ||
| | SonarqubeApiKey | String | API key of SonarQube account | | ||
| | SonarContainerImage | String | Container Image that will be used for sonar scanning purpose. | | ||
|
|
||
| * `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> | ||
| * `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> | ||
|
|
||
| * Click **Update Pipeline**. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.