Skip to content

Commit

Permalink
Fix markdown for Azure DevOps Marketplace (#10)
Browse files Browse the repository at this point in the history
Co-authored-by: Edouard <Zargath>
  • Loading branch information
Zargath authored Jul 9, 2020
1 parent f7af673 commit 422e2d8
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,17 @@ Azure DevOps extension for submitting BOM reports to Dependency-Track
## Parameters
### Base Settings
| Name | Id | Description | Required |
|---------|-|:-------------|------|
|---------|---|:-------------|------|
| BOM File Path | bomFilePath | The path where the BOM file is located. (e.g. 'directory/**/bom.xml'). | True |
| Project Id | dtrackProjId | The guid of the project in Dependency Track | True |
| API Key | dtrackAPIKey | The Dependency Track API key | True |
| Dependency Track URI | dtrackURI | The URL to the Dependency Track platform | True |

### Threshold Options
Setting these options will force the task to wait for the BOM analysis to be finished and the metrics to be recalculated before finishing the task.

| Name | Id | Description | Required |
|---------|-|:-------------|------|
|---------|---|:-------------|------|
| Action on Threshold | thresholdAction | The result of the task if the threshold is attained. Values are `none`, `warn`, and `error`. | False |
| Critical Vulnerability Count | thresholdCritical | Maximum number of critical vulnerabilities to tolerate. A value of `-1` disables this threshold. | False |
| High Vulnerability Count | thresholdHigh | Maximum number of high vulnerabilities to tolerate. A value of `-1` disables this threshold. | False |
Expand Down Expand Up @@ -60,7 +61,7 @@ steps:
## Thresholds Usage Example
This example finishes the pipeline with a warning if the number of low vulnerabilities surpasse zero.
![Low Threshold Surpassed Warning](/images/pipelineThresholdWarning.png?raw=true, "Low Threshold Surpassed Warning")
![Low Threshold Surpassed Warning](https://raw.githubusercontent.com/gsoft-inc/azure-pipelines-dependency-track/master/images/pipelineThresholdWarning.png, "Low Threshold Surpassed Warning")
```yaml
trigger:
- master
Expand Down

0 comments on commit 422e2d8

Please sign in to comment.