Skip to content

Fix isort-action usage documentation #2297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Fix isort-action usage documentation #2297

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6550a74
Fix isort-action usage documentation
jamescurtin Oct 14, 2024
b1a063f
Merge branch 'main' into patch-1
jamescurtin Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/configuration/github_action.md
View file
Open in desktop
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.9
- uses: isort/isort-action@master
python-version: 3.13
- uses: isort/isort-action@v1
with:
requirementsFiles: "requirements.txt requirements-test.txt"
```
Expand Down
Loading