1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
# Github Action
isort provides an official [Github Action][github-action-docs] that can be used as part of a CI/CD workflow to ensure a project's imports are properly sorted.
The action can be found on the [Github Actions Marketplace][python-isort].
## Usage
The `python-isort` plugin is designed to be run in combination with the [`checkout`][checkout-action] and [`setup-python`][setup-python] actions.
By default, it will run recursively from the root of the repository being linted and will exit with an error if the code is not properly sorted.
### Inputs
#### `isort-version`
Optional. Version of `isort` to use. Defaults to latest version of `isort`.
#### `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`.
#### `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.
If custom package installation is required, dependencies should be installed in a separate step before using this action.
!!! tip
It is important that the project's dependencies be installed before running isort so that third-party libraries are properly sorted.
### Outputs
#### `isort-result`
Output of the `isort` CLI.
### Example usage
```yaml
name: Run isort
on:
- push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.13
- uses: isort/isort-action@v1
with:
requirementsFiles: "requirements.txt requirements-test.txt"
```
[github-action-docs]: https://docs.github.com/en/free-pro-team@latest/actions
[python-isort]: https://github.com/marketplace/actions/python-isort
[checkout-action]: https://github.com/actions/checkout
[setup-python]: https://github.com/actions/setup-python
|
