PyCQA / PyCQA/bandit

Add report formatter for Github Actions annotations

Open
#1,301 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
8.3k
Forks
836
Avg merge
5d 3h
Merged PRs (30d)
1

Description

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 👍.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at Bandit's CLI formatter entry point and inspect the custom formatter path alongside existing output formats. Add a selectable GitHub Actions format matching the multiline annotation example, then verify the CLI output against that example with formatter tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.