Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: type checking setup (mypy) #3

Merged
merged 1 commit into from
Sep 20, 2024
Merged

ci: type checking setup (mypy) #3

merged 1 commit into from
Sep 20, 2024

Conversation

mih
Copy link
Member

@mih mih commented Sep 20, 2024

A hatch-based environment (types) is added.

Locally, hatch users can run

hatch run types:check

to get the checked out code type-checked.

Additionally, two workflows are added that test for typing issues. One (mypy-pr) only tests files that changed in a PR. The other (mypy-project) tests all code. The rational for having two separate tests is that individual PRs should not be blocked by typing issues that appear in the rest of the code base. This can happen when changes are forced into the mainline, or conditions change between (Python) versions.

A hatch-based environment (`types`) is added.

Locally, hatch users can run

```
hatch run types:check
```

to get the checked out code type-checked.

Additionally, two workflows are added that test for typing issues.
One (`mypy-pr`) only tests files that changed in a PR. The other
(`mypy-project`) tests all code. The rational for having two separate
tests is that individual PRs should not be blocked by typing issues
that appear in the rest of the code base. This can happen when changes
are forced into the mainline, or conditions change between (Python)
versions.
@mih mih merged commit e420e2a into main Sep 20, 2024
5 checks passed
@mih mih deleted the mypy branch September 20, 2024 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant