Skip to content

Commit

Permalink
README: update slugs from trailofbits to pypa (#26)
Browse files Browse the repository at this point in the history
* README: update slugs from trailofbits to pypa

Signed-off-by: William Woodruff <william@trailofbits.com>

* Update README.md

Signed-off-by: William Woodruff <william@trailofbits.com>
Co-authored-by: Dustin Ingram <di@users.noreply.github.com>
  • Loading branch information
woodruffw and di committed Sep 1, 2022
1 parent 2d48142 commit ac6a629
Showing 1 changed file with 27 additions and 24 deletions.
51 changes: 27 additions & 24 deletions README.md
@@ -1,12 +1,15 @@
gh-action-pip-audit
===================

[![CI](https://github.com/trailofbits/gh-action-pip-audit/actions/workflows/ci.yml/badge.svg)](https://github.com/trailofbits/gh-action-pip-audit/actions/workflows/ci.yml)
[![Self-test](https://github.com/trailofbits/gh-action-pip-audit/actions/workflows/selftest.yml/badge.svg)](https://github.com/trailofbits/gh-action-pip-audit/actions/workflows/selftest.yml)
[![CI](https://github.com/pypa/gh-action-pip-audit/actions/workflows/ci.yml/badge.svg)](https://github.com/pypa/gh-action-pip-audit/actions/workflows/ci.yml)
[![Self-test](https://github.com/pypa/gh-action-pip-audit/actions/workflows/selftest.yml/badge.svg)](https://github.com/pypa/gh-action-pip-audit/actions/workflows/selftest.yml)

A GitHub Action that uses [`pip-audit`](https://github.com/trailofbits/pip-audit)
A GitHub Action that uses [`pip-audit`](https://github.com/pypa/pip-audit)
to scan Python dependencies for known vulnerabilities.

This project is maintained in part by [Trail of Bits](https://www.trailofbits.com/)
with support from Google. This is not an official Google or Trail of Bits product.

## Index

* [Usage](#usage)
Expand All @@ -18,7 +21,7 @@ to scan Python dependencies for known vulnerabilities.

## Usage

Simply add `trailofbits/gh-action-pip-audit` to one of your workflows:
Simply add `pypa/gh-action-pip-audit` to one of your workflows:

```yaml
jobs:
Expand All @@ -28,7 +31,7 @@ jobs:
- uses: actions/checkout@v3
- name: install
run: python -m pip install .
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
```

Or, with a virtual environment:
Expand All @@ -44,7 +47,7 @@ jobs:
python -m venv env/
source env/bin/activate
python -m pip install .
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
virtual-environment: env/
```
Expand All @@ -68,15 +71,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.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
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.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
# NOTE: this can be `.`, for the current directory
inputs: path/to/project/
Expand Down Expand Up @@ -104,7 +107,7 @@ Example: use the virtual environment specified at `env/`, relative to the
current directory:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
virtual-environment: env/
# Note the absence of `input:`, since we're auditing the environment.
Expand All @@ -124,7 +127,7 @@ installed directly into the current environment are included.
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
local: true
```
Expand All @@ -141,7 +144,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.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
vulnerability-service: osv
```
Expand All @@ -156,7 +159,7 @@ It's directly equivalent to `pip-audit --require-hashes ...`.
Example:

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

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

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
summary: false
```
Expand All @@ -210,7 +213,7 @@ indices to search (such as a corporate index with private packages), see
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
index-url: https://example.corporate.local/simple
```
Expand All @@ -225,7 +228,7 @@ indexes to search when resolving dependencies. Each URL is whitespace-separated.
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
extra-index-urls: |
https://example.corporate.local/simple
Expand All @@ -242,7 +245,7 @@ ignore (i.e., exclude from the results) if present. Each ID is whitespace-separa
Example

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
ignore-vulns: |
GHSA-XXXX-YYYYYY
Expand Down Expand Up @@ -272,7 +275,7 @@ Example
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
internal-be-careful-allow-failure: true
```
Expand All @@ -291,7 +294,7 @@ Example
Example:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
internal-be-careful-debug: true
```
Expand All @@ -308,7 +311,7 @@ If you're auditing a requirements file, consider setting `no-deps: true` or
`require-hashes: true`:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
inputs: requirements.txt
require-hashes: true
Expand All @@ -317,14 +320,14 @@ If you're auditing a requirements file, consider setting `no-deps: true` or
or:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
inputs: requirements.txt
no-deps: true
```

See the
["`pip-audit` takes longer than I expect!"](https://github.com/trailofbits/pip-audit#pip-audit-takes-longer-than-i-expect)
["`pip-audit` takes longer than I expect!"](https://github.com/pypa/pip-audit#pip-audit-takes-longer-than-i-expect)
troubleshooting for more details.

### The action shows dependencies that aren't in my environment!
Expand All @@ -338,7 +341,7 @@ by the host system itself, or other Python projects that happen to be installed.
To minimize external dependencies, you can opt into a virtual environment:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
# must be populated earlier in the CI
virtual-environment: env/
Expand All @@ -348,7 +351,7 @@ and, more aggressively, specify that only dependencies marked as "local"
in the virtual environment should be included:

```yaml
- uses: trailofbits/gh-action-pip-audit@v1.0.0
- uses: pypa/gh-action-pip-audit@v1.0.0
with:
# must be populated earlier in the CI
virtual-environment: env/
Expand Down

0 comments on commit ac6a629

Please sign in to comment.