Skip to content

Commit

Permalink
Merge pull request #226 from ASFHyP3/remove-mypy-options
Browse files Browse the repository at this point in the history
remove mypy cli options
  • Loading branch information
jtherrmann authored Jan 17, 2025
2 parents 0ea9761 + 5558515 commit 41bd42a
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/reusable-mypy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ jobs:
- name: Check with MyPy
shell: bash -l {0}
run: |
mkdir .mypy_cache && mypy --install-types --ignore-missing-imports --non-interactive --pretty .
mkdir .mypy_cache && mypy .
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/)
and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.15.0]

### Removed
- The [`reusable-mypy`](.github/workflows/reusable-mypy.yml) workflow no longer passes any optional arguments to the `mypy` command. This makes it easier to run `mypy` locally, because the command is just:

```
mypy .
```

If you want to preserve the removed options for your project, you must now add them to `[tool.mypy]` in `pyproject.toml`:

```toml
install_types = true
non_interactive = true
pretty = true
ignore_missing_imports = true
```

Note that we discourage enabling `ignore_missing_imports` as a global option (see <https://github.com/ASFHyP3/actions/issues/225>). You can always find our currently recommended configuration options in the [README](https://github.com/ASFHyP3/actions#reusable-mypyyml).

## [0.14.0]

### Added
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,9 @@ warn_unused_ignores = true
warn_unreachable = true
strict_equality = true
check_untyped_defs = true
install_types = true
non_interactive = true
pretty = true
```

Populate the
Expand All @@ -294,6 +297,9 @@ requires-python = ">=3.10"
python_version = "3.10"
```

Note that you may need to enable additional options depending on the needs of your project.
See our [Mypy](https://github.com/ASFHyP3/.github-private/wiki/Mypy) wiki article for configuration tips.

### [`reusable-git-object-name.yml`](./.github/workflows/reusable-git-object-name.yml)

Outputs the human-readable git object name from [`git describe --dirty --tags --long --match "*[0-9]*"`](https://git-scm.com/docs/git-describe)
Expand Down

0 comments on commit 41bd42a

Please sign in to comment.