Skip to content

doc: update readme #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lhoupert merged 2 commits into from
Mar 27, 2026
Merged

doc: update readme #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
684525d
fox: update readme and ci action for automatic update
lhoupert Mar 27, 2026
34a39c1
doc: update dep
lhoupert Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/release-please.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ jobs:
env:
GITHUB_TOKEN: ${{ github.token }}
run: |
sed -i \
's|developmentseed/python-security-auditing@[^ ]*\( # v[0-9][^ ]*\)\?|developmentseed/python-security-auditing@${{ steps.release.outputs.sha }} # ${{ steps.release.outputs.tag_name }}|g' \
sed -i -E \
's|developmentseed/python-security-auditing@[^ ]+( # v[0-9][^ ]*)?|developmentseed/python-security-auditing@${{ steps.release.outputs.sha }} # ${{ steps.release.outputs.tag_name }}|g' \
README.md
git add README.md
git diff --cached --quiet && echo "README unchanged, skipping commit" && exit 0
Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ jobs:
security:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: developmentseed/python-security-auditing@v1
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: developmentseed/python-security-auditing@78fde899ecb5148e5e3343d534e5bf6bd4e7b035 # v0.2.0
```

This runs both bandit and pip-audit with sensible defaults: blocks the job on HIGH-severity code issues and on dependency vulnerabilities that have a fix available.
Expand All @@ -83,7 +83,7 @@ This runs both bandit and pip-audit with sensible defaults: blocks the job on HI
### uv project

```yaml
- uses: developmentseed/python-security-auditing@v1
- uses: developmentseed/python-security-auditing@78fde899ecb5148e5e3343d534e5bf6bd4e7b035 # v0.2.0
with:
package_manager: uv
bandit_scan_dirs: 'src/'
Expand All @@ -94,7 +94,7 @@ This runs both bandit and pip-audit with sensible defaults: blocks the job on HI
Block on any bandit finding at MEDIUM or above, and on all known vulnerabilities regardless of whether a fix exists:

```yaml
- uses: developmentseed/python-security-auditing@v1
- uses: developmentseed/python-security-auditing@78fde899ecb5148e5e3343d534e5bf6bd4e7b035 # v0.2.0
with:
package_manager: poetry
bandit_severity_threshold: medium
Expand All @@ -106,7 +106,7 @@ Block on any bandit finding at MEDIUM or above, and on all known vulnerabilities
Useful when you manage dependencies externally or run pip-audit in a separate job:

```yaml
- uses: developmentseed/python-security-auditing@v1
- uses: developmentseed/python-security-auditing@78fde899ecb5148e5e3343d534e5bf6bd4e7b035 # v0.2.0
with:
tools: bandit
bandit_scan_dirs: 'src/'
Expand All @@ -115,7 +115,7 @@ Useful when you manage dependencies externally or run pip-audit in a separate jo
### Project in a subdirectory (monorepo)

```yaml
- uses: developmentseed/python-security-auditing@v1
- uses: developmentseed/python-security-auditing@78fde899ecb5148e5e3343d534e5bf6bd4e7b035 # v0.2.0
with:
working_directory: services/api
package_manager: uv
Expand All @@ -127,7 +127,7 @@ Useful when you manage dependencies externally or run pip-audit in a separate jo
Run the audit and post the comment for visibility, but don't fail CI:

```yaml
- uses: developmentseed/python-security-auditing@v1
- uses: developmentseed/python-security-auditing@78fde899ecb5148e5e3343d534e5bf6bd4e7b035 # v0.2.0
with:
bandit_severity_threshold: low # report everything
pip_audit_block_on: none # never block
Expand Down
Loading