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

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

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

Last synced: about 2 hours ago
JSON representation

Annotate pull requests with mypy errors detected during CI

• Host: GitHub
• URL: https://github.com/pr-annotators/mypy-pr-annotator
• Owner: pr-annotators
• License: mit
• Created: 2022-03-31T13:52:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-05-11T10:44:24.000Z (over 2 years ago)
• Last Synced: 2024-10-31T10:49:45.358Z (15 days ago)
• Topics: annotations, code-review, github-actions, mypy, pull-requests, python
• Homepage:
• Size: 405 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mypy PR Annotator

![demo](images/demo.png)

## Usage

Annotate pull requests with mypy errors detected during CI.

Note: This doesn't install or run mypy, 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 mypy

        run: |

          pip install mypy

      - name: Add mypy annotator

        uses: pr-annotators/[email protected]

      - name: Run mypy

        run: |

          mypy src/

```