Skip to content

Commit

Permalink
Fix isort-action usage documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jamescurtin authored Oct 14, 2024
1 parent 7de1829 commit 6550a74
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/configuration/github_action.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ By default, it will run recursively from the root of the repository being linted

### Inputs

#### `isortVersion`
#### `isort-version`

Optional. Version of `isort` to use. Defaults to latest version of `isort`.

#### `sortPaths`
#### `sort-paths`

Optional. List of paths to sort, relative to your project root. Defaults to `.`

#### `configuration`

Optional. `isort` configuration options to pass to the `isort` CLI. Defaults to `--check-only --diff`.

#### `requirementsFiles`
#### `requirements-files`

Optional. Paths to python requirements files to install before running isort.
If multiple requirements files are provided, they should be separated by a space.
Expand All @@ -48,11 +48,11 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.8
- uses: isort/isort-action@master
python-version: 3.12
- uses: isort/isort-action@v1
with:
requirementsFiles: "requirements.txt requirements-test.txt"
```
Expand Down

0 comments on commit 6550a74

Please sign in to comment.