Skip to content

Add report formatter for Github Actions annotations #1301

@benjuade

Description

@benjuade

Is your feature request related to a problem? Please describe.
It may be useful to have a simple formatter compatible with Github Actions, in order to use it for CI jobs.

Describe the solution you'd like
The CLI shoud return a text formatted in a way that is compatible with Github Actions annotations fo workflows: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#about-workflow-commands

This is an example from pylint

************* Module src.MyClass                                                                                                                                                                                         
::warning file=app/src/MyClass.py,line=22,endline=22,col=8,title=W1203::Use lazy % formatting in logging functions

Describe alternatives you've considered
The official Github Action requires Advanced Security that is a paid addon also for paying teams for private repositories.

The custom formatter is not suitable, because the Github Actions annotations require a multiline structure.

Additional context
Pylint has a dedicated output formatter for Github actions: https://pylint.pycqa.org/en/latest/user_guide/usage/output.html (--output-format=github).

Love this idea? Give it a 👍. We prioritize fulfilling features with the most 👍.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions