Skip to content

Commit

Permalink
README: re-tag actions
Browse files Browse the repository at this point in the history
In prep for a 0.0.1 release.

Signed-off-by: William Woodruff <[email protected]>
  • Loading branch information
woodruffw committed Jun 14, 2022
1 parent a77cddb commit 1395474
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- uses: actions/checkout@v3
- name: install
run: pip install .
- uses: trailofbits/gh-action-pip-audit@v1
- uses: trailofbits/gh-action-pip-audit@v0.0.1
```
By default, `pip-audit` will run in "pip source" mode, meaning that it'll
Expand All @@ -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/gh-action-pip-audit@v1
- uses: trailofbits/gh-action-pip-audit@v0.0.1
with:
inputs: requirements.txt dev-requirements.txt
```

To audit a project that uses `pyproject.toml` for its dependencies:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1
- uses: trailofbits/gh-action-pip-audit@v0.0.1
with:
# NOTE: this can be `.`, for the current directory
inputs: path/to/project/
Expand All @@ -67,7 +67,7 @@ It's directly equivalent to `pip-audit --vulnerability-service=...`.
To audit with OSV instead of PyPI:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1
- uses: trailofbits/gh-action-pip-audit@v0.0.1
with:
vulnerability-service: osv
```
Expand All @@ -82,7 +82,7 @@ It's directly equivalent to `pip-audit --require-hashes ...`.
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1
- uses: trailofbits/gh-action-pip-audit@v0.0.1
with:
# NOTE: only works with requirements-style inputs
inputs: requirements.txt
Expand All @@ -99,7 +99,7 @@ It's directly equivalent to `pip-audit --no-deps ...`.
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1
- uses: trailofbits/gh-action-pip-audit@v0.0.1
with:
# NOTE: only works with requirements-style inputs
inputs: requirements.txt
Expand All @@ -117,7 +117,7 @@ is rendered at the end of the action.
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1
- uses: trailofbits/gh-action-pip-audit@v0.0.1
with:
summary: false
```
Expand Down Expand Up @@ -145,7 +145,7 @@ Example:
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1
- uses: trailofbits/gh-action-pip-audit@v0.0.1
with:
internal-be-careful-allow-failure: true
```
Expand Down

0 comments on commit 1395474

Please sign in to comment.