-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update workflow to do release and added overview.md to listing
- Loading branch information
1 parent
e9ed19f
commit 456d841
Showing
2 changed files
with
71 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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 |
---|---|---|
@@ -1,3 +1,29 @@ | ||
# dependabot-fail-task | ||
|
||
![Logo](src/images/dependabot-fail-task.png) | ||
Dependabot Fail Task for Azure Pipelines will fail a pipeline if any Dependabot alerts are detected on the repository. | ||
|
||
```yml | ||
- task: DependabotFailTask@1 | ||
displayName: Check Dependabot 🤖 | ||
inputs: | ||
auditMode: false | ||
failOnError: true | ||
failSeverity: 'low' | ||
githubServiceConnection: 'DependabotConnection-OAuth' | ||
``` | ||
## Options | ||
| Input Name | Type | Default | Description | | ||
|-------------------------|---------|------------|-------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| auditMode | boolean | `false` | Causes the task to return a warning when alerts are detected instead of failing the pipeline. Useful for testing the task before enabling it. | | ||
| enterpriseServerUrl | string | `null` | If you use GitHub Enterprise Server then you can specify your API base URL here. If you use Enterprise cloud, ignore this setting. | | ||
| failOnError | boolean | `true` | Causes the task to fail on any error, for example if GitHub API fails or any similar issue. | | ||
| failSeverity | string | `critical` | Fails pipeline when alerts are detect at or above this severity level. | | ||
| gitHubServiceConnection | string | `null` | Used to connect to GitHub API for Dependabot data. Must have correct permissions! (See *) | | ||
| githubToken | string | `null` | GitHub token used for connecting to GitHub API, please use a secure variable if you're using this option! Must have correct permissions (see *) | | ||
|
||
If you do not wish to specify the GitHub Token via either of the two above methods then you can also specify the environment variable: `GITHUB_TOKEN` | ||
which will be picked up if either of the first two options are not found. | ||
|
||
* - Please see docs/generate-token.md for more information on generating a token for use. |