Skip to content

Commit

Permalink
Add a new section to the README.md file to explain how to use the B…
Browse files Browse the repository at this point in the history
…andit scan GitHub Action

* Update the section to include an example of the GitHub Actions configuration for running a Bandit scan on a Python project
* Add a description of the configuration options and their purpose
  • Loading branch information
Setland34 committed Jan 23, 2025
1 parent 14b9f29 commit 799895b
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ cat ./etsthore.json

## Bandit Scan GitHub Action

To use the Bandit scan GitHub Action for running a Bandit scan on a Python project, you can add the following configuration to your GitHub Actions workflow file:
To use the Bandit scan GitHub Action for running a security scan on your Python project, you can follow the example GitHub Actions configuration below:

```yaml
name: Bandit Scan
Expand All @@ -116,3 +116,5 @@ jobs:
exit_zero: true
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
This configuration will run the Bandit scan on your Python project whenever there is a push or pull request. The `exit_zero: true` option ensures that the scan does not fail the workflow even if issues are found. The `GITHUB_TOKEN` is provided via `${{ secrets.GITHUB_TOKEN }}` for authentication.

0 comments on commit 799895b

Please sign in to comment.