-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: William Woodruff <[email protected]>
- Loading branch information
Showing
1 changed file
with
8 additions
and
8 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,7 +19,7 @@ jobs: | |
- uses: actions/checkout@v3 | ||
- name: install | ||
run: pip install . | ||
- uses: trailofbits/[email protected].1 | ||
- uses: trailofbits/[email protected].2 | ||
``` | ||
By default, `pip-audit` will run in "pip source" mode, meaning that it'll | ||
|
@@ -41,15 +41,15 @@ The `inputs` setting controls what sources `pip-audit` runs on. | |
To audit one or more requirements-style inputs: | ||
|
||
```yaml | ||
- uses: trailofbits/[email protected].1 | ||
- uses: trailofbits/[email protected].2 | ||
with: | ||
inputs: requirements.txt dev-requirements.txt | ||
``` | ||
|
||
To audit a project that uses `pyproject.toml` for its dependencies: | ||
|
||
```yaml | ||
- uses: trailofbits/[email protected].1 | ||
- uses: trailofbits/[email protected].2 | ||
with: | ||
# NOTE: this can be `.`, for the current directory | ||
inputs: path/to/project/ | ||
|
@@ -67,7 +67,7 @@ It's directly equivalent to `pip-audit --vulnerability-service=...`. | |
To audit with OSV instead of PyPI: | ||
|
||
```yaml | ||
- uses: trailofbits/[email protected].1 | ||
- uses: trailofbits/[email protected].2 | ||
with: | ||
vulnerability-service: osv | ||
``` | ||
|
@@ -82,7 +82,7 @@ It's directly equivalent to `pip-audit --require-hashes ...`. | |
Example: | ||
|
||
```yaml | ||
- uses: trailofbits/[email protected].1 | ||
- uses: trailofbits/[email protected].2 | ||
with: | ||
# NOTE: only works with requirements-style inputs | ||
inputs: requirements.txt | ||
|
@@ -99,7 +99,7 @@ It's directly equivalent to `pip-audit --no-deps ...`. | |
Example: | ||
|
||
```yaml | ||
- uses: trailofbits/[email protected].1 | ||
- uses: trailofbits/[email protected].2 | ||
with: | ||
# NOTE: only works with requirements-style inputs | ||
inputs: requirements.txt | ||
|
@@ -117,7 +117,7 @@ is rendered at the end of the action. | |
Example: | ||
|
||
```yaml | ||
- uses: trailofbits/[email protected].1 | ||
- uses: trailofbits/[email protected].2 | ||
with: | ||
summary: false | ||
``` | ||
|
@@ -145,7 +145,7 @@ Example: | |
Example: | ||
|
||
```yaml | ||
- uses: trailofbits/[email protected].1 | ||
- uses: trailofbits/[email protected].2 | ||
with: | ||
internal-be-careful-allow-failure: true | ||
``` | ||
|