Skip to content

Commit 3ac8fed

Browse files
authored
README: prep 1.0.7 (#40)
Signed-off-by: William Woodruff <[email protected]>
1 parent f7e9695 commit 3ac8fed

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
- uses: actions/checkout@v3
3333
- name: install
3434
run: python -m pip install .
35-
- uses: pypa/[email protected].6
35+
- uses: pypa/[email protected].7
3636
```
3737
3838
Or, with a virtual environment:
@@ -48,7 +48,7 @@ jobs:
4848
python -m venv env/
4949
source env/bin/activate
5050
python -m pip install .
51-
- uses: pypa/[email protected].6
51+
- uses: pypa/[email protected].7
5252
with:
5353
virtual-environment: env/
5454
```
@@ -72,15 +72,15 @@ The `inputs` setting controls what sources `pip-audit` runs on.
7272
To audit one or more requirements-style inputs:
7373

7474
```yaml
75-
- uses: pypa/[email protected].6
75+
- uses: pypa/[email protected].7
7676
with:
7777
inputs: requirements.txt dev-requirements.txt
7878
```
7979

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

8282
```yaml
83-
- uses: pypa/[email protected].6
83+
- uses: pypa/[email protected].7
8484
with:
8585
# NOTE: this can be `.`, for the current directory
8686
inputs: path/to/project/
@@ -108,7 +108,7 @@ Example: use the virtual environment specified at `env/`, relative to the
108108
current directory:
109109

110110
```yaml
111-
- uses: pypa/[email protected].6
111+
- uses: pypa/[email protected].7
112112
with:
113113
virtual-environment: env/
114114
# Note the absence of `input:`, since we're auditing the environment.
@@ -128,7 +128,7 @@ installed directly into the current environment are included.
128128
Example:
129129

130130
```yaml
131-
- uses: pypa/[email protected].6
131+
- uses: pypa/[email protected].7
132132
with:
133133
local: true
134134
```
@@ -145,7 +145,7 @@ It's directly equivalent to `pip-audit --vulnerability-service=...`.
145145
To audit with OSV instead of PyPI:
146146

147147
```yaml
148-
- uses: pypa/[email protected].6
148+
- uses: pypa/[email protected].7
149149
with:
150150
vulnerability-service: osv
151151
```
@@ -160,7 +160,7 @@ It's directly equivalent to `pip-audit --require-hashes ...`.
160160
Example:
161161

162162
```yaml
163-
- uses: pypa/[email protected].6
163+
- uses: pypa/[email protected].7
164164
with:
165165
# NOTE: only works with requirements-style inputs
166166
inputs: requirements.txt
@@ -177,7 +177,7 @@ It's directly equivalent to `pip-audit --no-deps ...`.
177177
Example:
178178

179179
```yaml
180-
- uses: pypa/[email protected].6
180+
- uses: pypa/[email protected].7
181181
with:
182182
# NOTE: only works with requirements-style inputs
183183
inputs: requirements.txt
@@ -195,7 +195,7 @@ is rendered at the end of the action.
195195
Example:
196196

197197
```yaml
198-
- uses: pypa/[email protected].6
198+
- uses: pypa/[email protected].7
199199
with:
200200
summary: false
201201
```
@@ -214,7 +214,7 @@ indices to search (such as a corporate index with private packages), see
214214
Example:
215215

216216
```yaml
217-
- uses: pypa/[email protected].6
217+
- uses: pypa/[email protected].7
218218
with:
219219
index-url: https://example.corporate.local/simple
220220
```
@@ -229,7 +229,7 @@ indexes to search when resolving dependencies. Each URL is whitespace-separated.
229229
Example:
230230

231231
```yaml
232-
- uses: pypa/[email protected].6
232+
- uses: pypa/[email protected].7
233233
with:
234234
extra-index-urls: |
235235
https://example.corporate.local/simple
@@ -246,7 +246,7 @@ ignore (i.e., exclude from the results) if present. Each ID is whitespace-separa
246246
Example
247247

248248
```yaml
249-
- uses: pypa/[email protected].6
249+
- uses: pypa/[email protected].7
250250
with:
251251
ignore-vulns: |
252252
GHSA-XXXX-YYYYYY
@@ -276,7 +276,7 @@ Example
276276
Example:
277277

278278
```yaml
279-
- uses: pypa/[email protected].6
279+
- uses: pypa/[email protected].7
280280
with:
281281
internal-be-careful-allow-failure: true
282282
```
@@ -290,7 +290,7 @@ to `pip-audit`.
290290
Example:
291291

292292
```yaml
293-
- uses: pypa/[email protected].6
293+
- uses: pypa/[email protected].7
294294
with:
295295
internal-be-careful-extra-flags: --not-a-real-pip-audit-flag
296296
```
@@ -307,7 +307,7 @@ If you're auditing a requirements file, consider setting `no-deps: true` or
307307
`require-hashes: true`:
308308

309309
```yaml
310-
- uses: pypa/[email protected].6
310+
- uses: pypa/[email protected].7
311311
with:
312312
inputs: requirements.txt
313313
require-hashes: true
@@ -316,7 +316,7 @@ If you're auditing a requirements file, consider setting `no-deps: true` or
316316
or:
317317

318318
```yaml
319-
- uses: pypa/[email protected].6
319+
- uses: pypa/[email protected].7
320320
with:
321321
inputs: requirements.txt
322322
no-deps: true
@@ -337,7 +337,7 @@ by the host system itself, or other Python projects that happen to be installed.
337337
To minimize external dependencies, you can opt into a virtual environment:
338338

339339
```yaml
340-
- uses: pypa/[email protected].6
340+
- uses: pypa/[email protected].7
341341
with:
342342
# must be populated earlier in the CI
343343
virtual-environment: env/
@@ -347,7 +347,7 @@ and, more aggressively, specify that only dependencies marked as "local"
347347
in the virtual environment should be included:
348348

349349
```yaml
350-
- uses: pypa/[email protected].6
350+
- uses: pypa/[email protected].7
351351
with:
352352
# must be populated earlier in the CI
353353
virtual-environment: env/
@@ -383,7 +383,7 @@ jobs:
383383
run: |
384384
pipx run pipfile-requirements Pipfile.lock > requirements.txt
385385
386-
- uses: pypa/[email protected].6
386+
- uses: pypa/[email protected].7
387387
with:
388388
inputs: requirements.txt
389389
```

0 commit comments

Comments
 (0)