Skip to content

github action for python's mypy type checker tool

License

Notifications You must be signed in to change notification settings

jpetrucciani/mypy-check

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

mypy-check

GitHub Action for mypy

Make sure you have a mypy.ini or setup.cfg file at the root of your repository!

Inputs

path

Optional The path to run mypy on

Default "."

mypy_flags

Optional Optional mypy flags (refer to mypy --help)

Default ""

requirements

Optional Optional, if not empty: parameters to pass to pip install before running mypy

Default ""

requirements_file

Optional Optional, if not empty: a file to pass to pip install -r before running mypy

Default ""

python_version

Optional Optional, Python version to use

Default "3.10"

Outputs

None

Example usage

uses: jpetrucciani/mypy-check@master

# or specify a path!
uses: jpetrucciani/mypy-check@master
with:
  path: '.'


# or specify additional mypy flags!
uses: jpetrucciani/mypy-check@master
with:
  mypy_flags: '--config-file .mypy.ini'