tsuyoshicho/Run mypy with reviewdog
🐶 Run mypy with reviewdog on pull requests to improve code review experience.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | GITHUB_TOKEN | no | ${{ github.token }} |
| workdir | Working directory of where to run mypy command. Relative to the root directory. | no | . |
| target | Target files and/or directories of mypy command. Enumerate in a space-separated list. Relative to the working directory. | no | . |
| execute_command | mypy execute command. Normally it is "mypy", but for example "poetry run mypy" if you want to run at Poetry without activating the virtual environment. | no | mypy |
| setup_command | mypy setup command. Runs when "setup_method" is "install" or required by "adaptive". If you want to fix the version of mypy, set the value as in the following example. "pip install mypy==1.6.0" | no | pip install mypy |
| setup_method | mypy setup method. Select from below. "nothing" - no setup process. This option expects the user to prepare the environment (ex. previous workflow step executed "pip install -r requirements.txt"). If you do not want immediately package installation (e.g., in a poetry environment), must be this. "adaptive" - Check "execute_command" with "--version" is executable. If it can be executed, do the same as "nothing", otherwise do the same as "install". "install" - execute "setup_command". Incorrect values behave as "adaptive". | no | nothing |
| install_types | Pre-run mypy and check for missing stubs. Then perform stub installation. (ex. ${execute_command} --install-types) | no | true |
| level | Report level for reviewdog [info,warning,error] | no | error |
| reporter | Reporter of reviewdog command [github-pr-check,github-pr-review]. | no | github-pr-check |
| filter_mode | Filtering mode for the reviewdog command [added,diff_context,file,nofilter]. Default is added. | no | added |
| fail_level | Optional. Exit code control for reviewdog, [none,any,info,warning,error] Default is `none`. | — | none |
| fail_on_error | Deprecated. Optional. Exit code for reviewdog when errors are found [true,false] Default is `false`. If `true` is set, it will be interpreted as "-fail-level=error". But if "-fail-level" is set non-`none`, it will be ignored. | — | false |
| reviewdog_flags | Additional reviewdog flags | no | "" |
| mypy_flags | mypy options (default: <none>) | no | "" |
| tool_name | Tool name to use for reviewdog reporter | — | mypy |
| ignore_note | Currently, this option is always true. Ignore "note: entries" that as reported by mypy. Old description: Ignore note entry. mypy report some error with optional note entry. This option is workaround. | no | true |
| output_json | Use the JSON output format available in mypy 1.11 or higher. This option defaults to false due to version limitations and because it is still experimental. Note the mypy version when setting to true. | no | false |
Outputs
no outputs