This is a GitHub Action to run mypy against your repository and annotate results directly in your pull requests using GitHub Checks.

This action accepts the following input parameters:

• checkName (required): The name of the GitHub check to add annotations to. This should generally match the job name in your workflow.

• mypyFlags (optional): Additional flags to pass to the mypy command (e.g., --config-file pyproject.toml). Default: ''

• mypyFiles (optional): Files or directories on which to run mypy. Default: . (runs on the full project)

Add the following to your workflow file (e.g. .github/workflows/lint.yml):

name: lint

on:
  push:
    paths:
      - '*.py'

jobs:
  mypy:
    runs-on: ubuntu-latest
    steps:
      - name: Setup Python
        uses: aactions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
        with:
          python-version: 3.13.0
          architecture: x64
      - name: Checkout
        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - name: Install mypy
        run: pip install mypy
      - name: Run mypy
        uses: amilcarlucas/mypy-github-action@releases/v2.0.0
        with:
          checkName: 'lint'   # NOTE: this needs to be the same as the job name
          mypyFlags: '--config-file pyproject.toml'
          mypyFiles: '.'
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

The action runs mypy on the specified files with the given flags. Any type errors found are annotated directly in the PR using GitHub Checks. The check will fail if any errors are found, making it easy to enforce type safety in your CI.

Inputs Reference

This GitHub Action was made with reference to flake8-github-action This is forked from sasanquaneuf.