-
Notifications
You must be signed in to change notification settings - Fork 0
Pin ty to 0.0.56 #25
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
Merged
Pin ty to 0.0.56 #25
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # ADR-004: Pin the ty typechecker version | ||
|
|
||
| ## Status | ||
|
|
||
| Accepted. | ||
|
|
||
| ## Context | ||
|
|
||
| Both the parent repository and generated projects typecheck with `ty`. The | ||
| parent Makefile ran it through an unpinned `uvx` invocation, and the templated | ||
| dev dependency group declared `"ty"` without a version, so every install | ||
| resolved the latest release. | ||
|
|
||
| `ty` is pre-1.0 and its diagnostics change between releases. When ty 0.0.56 | ||
| landed, estate repositories with unpinned installations broke without any code | ||
| change: the falcon-correlate and polythene main branches were red for days. | ||
| An unpinned typechecker makes gate outcomes depend on release timing rather | ||
| than on the code under review. | ||
|
|
||
| ## Decision | ||
|
|
||
| Pin `ty` to an exact version everywhere it is installed: | ||
|
|
||
| - the parent Makefile's `typecheck` target runs `uvx … ty@0.0.56 check`; | ||
| - the templated dev dependency group declares `"ty==0.0.56"`, which pins the | ||
| generated `uv run ty` invocations; | ||
| - contract tests assert the pinned forms so drift fails the suite. | ||
|
|
||
| Version bumps are deliberate: update the pin, fix any new diagnostics it | ||
| surfaces, and land both in a single pull request. Update the parent Makefile, | ||
| the templated dev group, and the contract assertions together, and re-render | ||
| both template toggle states before merging. | ||
|
|
||
| ## Consequences | ||
|
|
||
| - Gate results are reproducible: a new ty release cannot break `main` in the | ||
| parent repository or in generated projects. | ||
| - New ty diagnostics arrive only when a maintainer chooses to take them, | ||
| alongside the fixes they require. | ||
| - The pin must be maintained by hand; generated projects inherit whatever | ||
| version the template pinned at render time and manage their own bumps | ||
| thereafter. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,7 +14,7 @@ dev = [ | |
| "pip-audit", | ||
| "ruff", | ||
| "pyright", | ||
| "ty", | ||
| "ty==0.0.56", | ||
| "pytest-timeout", | ||
| "pytest-xdist", | ||
| ] | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.