Skip to content

Commit 3b57bfd

Browse files
authored
chore: use the new github actions reporter for pylint (#427)
Signed-off-by: Henry Schreiner <[email protected]>
1 parent a920e61 commit 3b57bfd

File tree

5 files changed

+8
-43
lines changed

5 files changed

+8
-43
lines changed

docs/pages/guides/gha_basic.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -224,10 +224,8 @@ for a plugin to do this with pytest.
224224

225225
You can also do this
226226
[by supplying matchers](https://github.com/actions/toolkit/blob/main/docs/problem-matchers.md),
227-
which tell GitHub to look for certain patterns, such as
228-
`echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json"`. Do keep
229-
in mind you can only see up to 10 matches per type per step, and a total of 50
230-
matchers.
227+
which tell GitHub to look for certain patterns. Do keep in mind you can only see
228+
up to 10 matches per type per step, and a total of 50 matchers.
231229

232230
### Common useful actions
233231

docs/pages/guides/style.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -862,12 +862,13 @@ And a noxfile entry:
862862
@nox.session
863863
def pylint(session: nox.Session) -> None:
864864
session.install("-e.")
865-
session.install("pylint")
865+
session.install("pylint>=3.2")
866866
session.run("pylint", "<your package>", *session.posargs)
867867
```
868868

869-
And you can add this to your GitHub Actions using `run: pipx run nox -s pylint`.
870-
You can replace `src` with the module name.
869+
And you can add this to your GitHub Actions using
870+
`run: pipx run nox -s pylint -- --output-format=github`. You can replace
871+
`<your package>` with the module name.
871872

872873
## Jupyter notebook support
873874

{{cookiecutter.project_name}}/.github/matchers/pylint.json

Lines changed: 0 additions & 32 deletions
This file was deleted.

{{cookiecutter.project_name}}/.github/workflows/ci.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@ jobs:
3131
with:
3232
extra_args: --hook-stage manual --all-files
3333
- name: Run PyLint
34-
run: |
35-
echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json"
36-
pipx run nox -s pylint
34+
run: pipx run nox -s pylint -- --output-format=github
3735

3836
checks:
3937
name: {% raw %}Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}{% endraw %}

{{cookiecutter.project_name}}/noxfile.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def pylint(session: nox.Session) -> None:
3131
"""
3232
# This needs to be installed into the package environment, and is slower
3333
# than a pre-commit check
34-
session.install(".", "pylint")
34+
session.install(".", "pylint>=3.2")
3535
session.run("pylint", "{{ cookiecutter.__project_slug }}", *session.posargs)
3636

3737

0 commit comments

Comments
 (0)