Skip to content

Commit cce8844

Browse files
committed
README: prep for 1.0.0
Signed-off-by: William Woodruff <[email protected]>
1 parent 04c269e commit cce8844

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
- uses: actions/checkout@v3
2929
- name: install
3030
run: python -m pip install .
31-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
31+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
3232
```
3333
3434
Or, with a virtual environment:
@@ -44,7 +44,7 @@ jobs:
4444
python -m venv env/
4545
source env/bin/activate
4646
python -m pip install .
47-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
47+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
4848
with:
4949
virtual-environment: env/
5050
```
@@ -68,15 +68,15 @@ The `inputs` setting controls what sources `pip-audit` runs on.
6868
To audit one or more requirements-style inputs:
6969

7070
```yaml
71-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
71+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
7272
with:
7373
inputs: requirements.txt dev-requirements.txt
7474
```
7575

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

7878
```yaml
79-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
79+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
8080
with:
8181
# NOTE: this can be `.`, for the current directory
8282
inputs: path/to/project/
@@ -104,7 +104,7 @@ Example: use the virtual environment specified at `env/`, relative to the
104104
current directory:
105105

106106
```yaml
107-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
107+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
108108
with:
109109
virtual-environment: env/
110110
# Note the absence of `input:`, since we're auditing the environment.
@@ -124,7 +124,7 @@ installed directly into the current environment are included.
124124
Example:
125125

126126
```yaml
127-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
127+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
128128
with:
129129
local: true
130130
```
@@ -141,7 +141,7 @@ It's directly equivalent to `pip-audit --vulnerability-service=...`.
141141
To audit with OSV instead of PyPI:
142142

143143
```yaml
144-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
144+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
145145
with:
146146
vulnerability-service: osv
147147
```
@@ -156,7 +156,7 @@ It's directly equivalent to `pip-audit --require-hashes ...`.
156156
Example:
157157

158158
```yaml
159-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
159+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
160160
with:
161161
# NOTE: only works with requirements-style inputs
162162
inputs: requirements.txt
@@ -173,7 +173,7 @@ It's directly equivalent to `pip-audit --no-deps ...`.
173173
Example:
174174

175175
```yaml
176-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
176+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
177177
with:
178178
# NOTE: only works with requirements-style inputs
179179
inputs: requirements.txt
@@ -191,7 +191,7 @@ is rendered at the end of the action.
191191
Example:
192192

193193
```yaml
194-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
194+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
195195
with:
196196
summary: false
197197
```
@@ -210,7 +210,7 @@ indices to search (such as a corporate index with private packages), see
210210
Example:
211211

212212
```yaml
213-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
213+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
214214
with:
215215
index-url: https://example.corporate.local/simple
216216
```
@@ -225,7 +225,7 @@ indexes to search when resolving dependencies. Each URL is whitespace-separated.
225225
Example:
226226

227227
```yaml
228-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
228+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
229229
with:
230230
extra-index-urls: |
231231
https://example.corporate.local/simple
@@ -242,7 +242,7 @@ ignore (i.e., exclude from the results) if present. Each ID is whitespace-separa
242242
Example
243243

244244
```yaml
245-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
245+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
246246
with:
247247
ignore-vulns: |
248248
GHSA-XXXX-YYYYYY
@@ -272,7 +272,7 @@ Example
272272
Example:
273273

274274
```yaml
275-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
275+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
276276
with:
277277
internal-be-careful-allow-failure: true
278278
```
@@ -291,7 +291,7 @@ Example
291291
Example:
292292

293293
```yaml
294-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
294+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
295295
with:
296296
internal-be-careful-debug: true
297297
```
@@ -308,7 +308,7 @@ If you're auditing a requirements file, consider setting `no-deps: true` or
308308
`require-hashes: true`:
309309

310310
```yaml
311-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
311+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
312312
with:
313313
inputs: requirements.txt
314314
require-hashes: true
@@ -317,7 +317,7 @@ If you're auditing a requirements file, consider setting `no-deps: true` or
317317
or:
318318

319319
```yaml
320-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
320+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
321321
with:
322322
inputs: requirements.txt
323323
no-deps: true
@@ -338,7 +338,7 @@ by the host system itself, or other Python projects that happen to be installed.
338338
To minimize external dependencies, you can opt into a virtual environment:
339339

340340
```yaml
341-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
341+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
342342
with:
343343
# must be populated earlier in the CI
344344
virtual-environment: env/
@@ -348,7 +348,7 @@ and, more aggressively, specify that only dependencies marked as "local"
348348
in the virtual environment should be included:
349349

350350
```yaml
351-
- uses: trailofbits/gh-action-pip-audit@v0.0.6
351+
- uses: trailofbits/gh-action-pip-audit@v1.0.0
352352
with:
353353
# must be populated earlier in the CI
354354
virtual-environment: env/

0 commit comments

Comments
 (0)