https://github.com/pr-annotators/flake8-pr-annotator

Annotate pull requests with flake8 errors detected during CI
https://github.com/pr-annotators/flake8-pr-annotator

annotations code-review flake8 github-actions pull-requests python

Last synced: about 2 hours ago
JSON representation

Annotate pull requests with flake8 errors detected during CI

• Host: GitHub
• URL: https://github.com/pr-annotators/flake8-pr-annotator
• Owner: pr-annotators
• License: mit
• Created: 2022-03-31T14:55:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-04-01T10:04:07.000Z (over 2 years ago)
• Last Synced: 2024-10-17T09:00:18.010Z (29 days ago)
• Topics: annotations, code-review, flake8, github-actions, pull-requests, python
• Homepage:
• Size: 323 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Flake8 PR Annotator

![demo](images/demo.png)

## Usage

Annotate pull requests with flake8 errors detected during CI.

Note: This doesn't install or run flake8, it just sets up the PR annotations.

### Example workflow

```yaml

name: My Workflow

on: [push, pull_request]

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@master

      - name: Set up Python 3.8

        uses: actions/setup-python@v2

        with:

          python-version: "3.8"

        

      - name: Install flake8

        run: |

          pip install flake8

      - name: Add flake8 annotator

        uses: pr-annotators/[email protected]

      - name: Run flake8

        run: |

          flake8 src/

```