Skip to content

Commit

Permalink
Merge pull request #3 from deining/fix-typo
Browse files Browse the repository at this point in the history
README.md: Fix typo
  • Loading branch information
mdegis authored Nov 1, 2023
2 parents 85fcc34 + 985a46c commit a23d8be
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Bandit Action
From Bandit documantation:
From Bandit documentation:

Bandit is a tool designed to find common security issues in Python code. To do this Bandit processes each file, builds an AST from it, and runs appropriate plugins against the AST nodes. Once Bandit has finished scanning all the files it generates a report.

Expand All @@ -18,21 +18,21 @@ This Github Action will let you use Bandit with the highly configurable paramete

### `level`

**Optional** Report only issues of a given severity level or higher.
**Optional** Report only issues of a given severity level or higher.
Can be LOW, MEDIUM or HIGH. Default is UNDEFINED (everything).

**Default** `"UNDEFINED"`

### `confidence`

**Optional** Report only issues of a given confidence level or higher.
**Optional** Report only issues of a given confidence level or higher.
Can be LOW, MEDIUM or HIGH. Default is UNDEFINED (everything).

**Default** `"UNDEFINED"`

### `excluded_paths`

**Optional** Comma-separated list of paths (glob patterns supported) to exclude from scan
**Optional** Comma-separated list of paths (glob patterns supported) to exclude from scan
(note that these are in addition to the excluded paths provided in the config file) (default is from the Bandit itself)

**Default** `".svn,CVS,.bzr,.hg,.git,__pycache__,.tox,.eggs,*.egg"`
Expand Down Expand Up @@ -64,7 +64,7 @@ You can see the comment at the PR if there is an at least one issue.
## Example usage
```yml
uses: mdegis/bandit-action@v1
with:
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
path: "."
level: high
Expand Down

0 comments on commit a23d8be

Please sign in to comment.