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

build: configure type checkers to run on min supported version #2474

Merged
merged 9 commits into from
Oct 21, 2023

Conversation

peterschutt
Copy link
Contributor

Pull Request Checklist

  • New code has 100% test coverage
  • (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
  • (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR
  • Pre-Commit Checks were ran and passed
  • Tests were ran and passed

Description

This PR modifies our type-checking to run on the minimum supported version, instead of the latest.

Rationale:

  • Reduce incidence of backward incompatible changes.
  • Improve local development workflow - prior to this change, local development requires 2 python environments, 1 for 3.8 for dev/running tests, and one for 3.12 to run the type checkers. After this change developers will only have to run a single python environment for running both tests and type-checks.

Close Issue(s)

This PR modifies our type-checking to run on the minimum supported version, instead of the latest.

Rationale:
- Reduce incidence of backward incompatible changes.
- Improve local development workflow - prior to this change, local development requires 2 python environments, 1 for 3.8 for dev/running tests, and one for 3.12 to run the type checkers. After this change developers will only have to run a single python environment for running both tests and type-checks.
@peterschutt peterschutt requested review from a team as code owners October 20, 2023 00:02
.github/workflows/ci.yml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
tests/helpers.py Outdated Show resolved Hide resolved
Copy link
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe can suggest RTX as well

Copy link
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these required for end users or just available? Sorry I haven't caught up to this new change

.github/workflows/ci.yml Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@peterschutt
Copy link
Contributor Author

Are these required for end users or just available? Sorry I haven't caught up to this new change

Sorry @JacobCoffee can you clarify the question please?

@peterschutt
Copy link
Contributor Author

Maybe can suggest RTX as well

In CONTRIBUTING? I don't have any experience with it - if you'd like to add something, I'm open to it.

Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Last final nit :)

CONTRIBUTING.rst Outdated Show resolved Hide resolved
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
@sonarcloud
Copy link

sonarcloud bot commented Oct 21, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication

Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! Great work!

@github-actions
Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2474

@peterschutt peterschutt merged commit 68de124 into main Oct 21, 2023
22 checks passed
@peterschutt peterschutt deleted the type-check-on-3.8 branch October 21, 2023 05:57
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.

None yet

4 participants