-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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
docs: add upgrading guide #12633
docs: add upgrading guide #12633
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff! can you add something for #12638 as well?
Surely. I am trying to include as much as possible. Working on that (; |
Happy to land as is once prettier is happy, and just make sure to circle back before releasing a stable version 🙂 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff! I'll probably add a section for new features people can use (making this a "what's new" thing), but this is a great start, thank you so much!
|
||
:::info | ||
|
||
The TypeScript examples from this page will only work as document if you import `jest` from `'@jest/globals'`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume @types/jest
will be updated. Something about "until @types/jest@28
is released"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, updating @types/jest
would be the best. I just think, if that will be fixed, we will be adding it upgrading guide. Sort-of: "you should use this version of @types/jest
". So this note will disappear naturally. Perhaps?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reasonable 👍
Yes, I was thinking about "What's New". That would work with version docs nicely as well. Will do it as separate PR. |
Will make the blog post more of an highlights, which is nice. Prose for blog posts are always a pain 😅 |
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Summary
Jest v28 will have many breaking changes. Adding an upgrade guide would help users to refactor their tests.
Test plan
Green CI and preview on Netlify.