GitHub workflow output format

[codingjoe]

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}} . --out

However, 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

https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions

[codingjoe]

I'd be happy to provide a patch myself, if that were helpful 😃

[jacobtylerwalls]

Hey @codingjoe, we have that already (example, release note), but clearly we need some docs to make it more discoverable.

[Pierre-Sassoulas]

If we do #4322, the discoverability would be great.

[codingjoe]

@jacobtylerwalls thanks mate 🥇 I could have just tried github ;)
I created a tiny PR to help the next person: #10272