mypy

This action will set up python, install requirements, and then run mypy. Passing checks are gated by any settings defined in mypy’s configuration. By default, mypy runs in the root directory of the repo, ignoring the docs and confluence directories, which may be present for doc building. The arguments to mypy may be overridden by supplying a args input to the action.

This action will use a mypy.ini (or .mypy.ini, pyproject.toml, or setup.cfg) file in the root directory of the calling repository to configure how mypy runs. See https://mypy.readthedocs.io/en/stable/config_file.html.

This action can be called independently or called via the internal-actions/.github/workflows/static-analysis.yml reusable workflow.

Templates

name: mypy

on:
  push:
    branches: [main]  # Or the name of your default branch
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  mypy:
    name: mypy
    runs-on: ubuntu-latest
    steps:
      - name: Run mypy
        uses: GenapsysInc/internal-actions/reusable-actions/mypy@main
        with:
          python-version: <default 3.10>
          requirements-txt: <path/to/requirements.txt>
          build-command: <optional command to run before mypy>
          mypy-version: <default latest>
          args: <default --exclude docs --exclude confluence .>