-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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
chore: upgrade to TS 5.6 + temporarily use skipLibCheck for TS 5.6 #10486
Merged
Conversation
This file contains 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
slorber
added
pr: maintenance
This PR does not produce any behavior differences to end users when upgrading.
and removed
CLA Signed
Signed Facebook CLA
labels
Sep 10, 2024
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
|
slorber
changed the title
chore: upgrade to TS 5.6 + temporarily use skipLibCheck for latest TS version
chore: upgrade to TS 5.6 + temporarily use skipLibCheck for TS 5.6
Sep 10, 2024
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Size Change: +372 B (0%) Total Size: 11.5 MB ℹ️ View Unchanged
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
CLA Signed
Signed Facebook CLA
pr: maintenance
This PR does not produce any behavior differences to end users when upgrading.
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.
Motivation
Upgrade repo to TS 5.6
Also to unlock CI tests temporarily turn on
skipLibCheck
on a few CI workflows.Note: historically we use
skipLibCheck: false
on our website because we write.d.ts
files manually for our themes and runningtsc
on themes won't report type errors in those.d.ts
files, so the workaround is to useskipLibCheck: false
.Problem: this doesn't only test our types, but all the types of all our libs too, and when a new TypeScript version gets published, it often happens that libs have type problems that block our CI.
For example today we had this TS 5.6 + Webpack error: webpack/webpack#18751
In the future, to avoid blocking our CI due to temporary TS type errors after a new release, I think we should enable/disable
skipLibCheck
depending on version:skipLibCheck: false
skipLibCheck: false
(temporarily enabled but will revert)skipLibCheck: true
(avoids blocking CI after TS release)Since I just upgraded to the latest TS 5.6, we have TS current = TS max = TS 5.6. Once the temporary type errors are fixed, I'll restore TS current:
skipLibCheck: false
Note: a better solution would be to create a new workflow that only checks our own packages and
.d.ts
files instead of all the libs we use. Eventually: stop writing.d.ts
files manually (if possible, not easy with our theming system).Test Plan
CI
Test links
https://deploy-preview-10486--docusaurus-2.netlify.app/