Skip to content

Commit a5a5a84

Browse files
Doc/how to use isort 5 (#8)
* update docs
1 parent 8c5084c commit a5a5a84

File tree

4 files changed

+47
-4
lines changed

4 files changed

+47
-4
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Python Lint
1+
name: all-lints
22

33
on: [push]
44

@@ -8,6 +8,6 @@ jobs:
88

99
steps:
1010
- uses: actions/checkout@v1
11-
- uses: ricardochaves/python-lint@master
11+
- uses: ricardochaves/python-lint@v1.1.0
1212
with:
1313
python-root-list: "tests"
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: with-isort-5-lint
2+
3+
on: [push]
4+
5+
jobs:
6+
lint:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- uses: actions/checkout@v1
11+
- uses: ricardochaves/[email protected]
12+
with:
13+
python-root-list: "tests"
14+
use-pylint: false
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: without-isort-5-lint
2+
3+
on: [push]
4+
5+
jobs:
6+
lint:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- uses: actions/checkout@v1
11+
- uses: ricardochaves/[email protected]
12+
with:
13+
python-root-list: "tests"
14+
use-isort: false

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
# python-lint
22

3+
## Status
4+
35
<p align="left">
4-
<a href="https://github.com/ricardochaves/python-lint"><img alt="GitHub Actions status" src="https://github.com/ricardochaves/python-lint/workflows/Python%20Lint/badge.svg"></a>
5-
</p>
6+
<a href="https://github.com/ricardochaves/python-lint"><img alt="All lints status" src="https://github.com/ricardochaves/python-lint/workflows/all-lints/badge.svg"></a></p> <p align="left">
7+
<a href="https://github.com/ricardochaves/python-lint"><img alt="With Isort 5 status" src="https://github.com/ricardochaves/python-lint/workflows/with-isort-5-lint/badge.svg"></a></p> <p align="left">
8+
<a href="https://github.com/ricardochaves/python-lint"><img alt="Without isort 5 status" src="https://github.com/ricardochaves/python-lint/workflows/without-isort-5-lint/badge.svg"></a></p>
9+
10+
> [Pylint](https://www.pylint.org/) is not compatible with [Isort 5](https://github.com/timothycrosley/isort). So if you use all enabled lints, it fails in version 1.2.0
11+
12+
## Limitations
13+
14+
You can't use Isort 5 with Pylint.
15+
16+
If you wanna use Pylint with isort 4 use the `v1.1.0` version.
17+
18+
If you wanna use Isort 5 without pylint use the version `v1.2.0` and disable pylint
19+
20+
## About
621

722
This action must be used for aplication the bids:
823

0 commit comments

Comments
 (0)