Repository navigation
GitHub workflow output format #10260
Description
Current problem
Hi there 👋,
GitHub supports a special output format for workflow, that enables the workflow to create code comments on pull-requests.
We currently use a GitHub workflow similar to this:
pylint:
name: PyLint
runs-on: ubuntu-latest
env:
DJANGO_SETTINGS_MODULE: my.app.settings
strategy:
matrix:
type:
- name: error
enable: E,F
disable: E0401
- name: warning
enable: W
disable: ''
- name: notice
enable: R,C
disable: C0114,C0115,C0116
- name: debug
enable: I
disable: ''
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version-file: 'pyproject.toml'
- run: python -m pip install pylint
- run: pylint --load-plugins pylint_django --exit-zero --msg-template='::${{matrix.type.name}} file={path},line={line},lineEnd={end_line},col={column},colEnd={end_column},title={symbol} ({msg_id})::{msg}' --disable=all --enable=${{matrix.type.enable}} --disable=${{matrix.type.disable}} . --outHowever, this will cause PyLint to run multiple times, wasting precious compute time.
Desired solution
I'd love to native support --output-format=github that correctly sets the message type for GitHub. This is the only thing, that you currently can't achieve with --message-template.
Since GitHub is a rather popular collaboration platform, I believe this feature would be welcome by other community members 😉
Additional context
Reacted by Rust Saiargaliev, Johannes Maron, Jörg Benesch, gwassing and Sebastian Kapunkt
Activity
codingjoe commentedon Mar 7, 2025
I'd be happy to provide a patch myself, if that were helpful 😃
jacobtylerwalls commentedon Mar 8, 2025
Hey @codingjoe, we have that already (example, release note), but clearly we need some docs to make it more discoverable.
Pierre-Sassoulas commentedon Mar 8, 2025
If we do #4322, the discoverability would be great.
Ref pylint-dev#10260 -- Add documentation for the github output format
codingjoe commentedon Mar 10, 2025
@jacobtylerwalls thanks mate 🥇 I could have just tried
github;)I created a tiny PR to help the next person: #10272
Ref #10260 -- Add documentation for the github output format (#10272)
Ref #10260 -- Add documentation for the github output format (#10272)
Ref #10260 -- Add documentation for the github output format (#10272) (…