From a96d28f120cffb448be0bee5e1011dd5feba41ba Mon Sep 17 00:00:00 2001 From: Federico Builes Date: Tue, 7 Jun 2022 06:19:13 +0200 Subject: [PATCH] Remove configuration docs until we have a proper release. --- README.md | 29 +---------------------------- 1 file changed, 1 insertion(+), 28 deletions(-) diff --git a/README.md b/README.md index e68f294..3501db3 100644 --- a/README.md +++ b/README.md @@ -28,34 +28,7 @@ jobs: uses: actions/dependency-review-action@v1 ``` -Please keep in mind that you need a GitHub Advanced Security license -if you're running this Action on private repos. - -## Configuration - -The Dependency Review Action uses a YAML configuration file. It -expects this file to be named `dependency-review.yml`, inside your -`.github/` directory. - -Here's a sample configuration file: - -```yaml -fail_on_severity: low -``` - -[Here](https://github.com/actions/dependency-review-action/blob/main/.github/dependency-review.yml) -you can see an example of the configuration file we use for this repository. - -### Severity - -By default this Action blocks any pull request that contains a -vulnerability of any severity level. You can override this behavior by -setting an option in your configuration file: - -```yaml -# choose one of: 'critical', 'high', 'moderate' or 'low' -fail_on_severity: high -``` +Please keep in mind that you need a GitHub Advanced Security license if you're running this Action on private repos. ## Getting help