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

docs: add upgrading guide #12633

Merged
merged 5 commits into from Apr 18, 2022
Merged

docs: add upgrading guide #12633

merged 5 commits into from Apr 18, 2022

Conversation

mrazauskas
Copy link
Contributor

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.

Copy link
Member

@SimenB SimenB left a 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?

@mrazauskas
Copy link
Contributor Author

Great stuff! can you add something for #12638 as well?

Surely. I am trying to include as much as possible. Working on that (;

@SimenB
Copy link
Member

SimenB commented Apr 8, 2022

Happy to land as is once prettier is happy, and just make sure to circle back before releasing a stable version 🙂

@mrazauskas mrazauskas marked this pull request as ready for review April 17, 2022 13:59
@mrazauskas mrazauskas requested a review from SimenB April 17, 2022 13:59
docs/UpgradingToJest28.md Outdated Show resolved Hide resolved
Copy link
Member

@SimenB SimenB left a 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!

docs/UpgradingToJest28.md Outdated Show resolved Hide resolved
docs/UpgradingToJest28.md Outdated Show resolved Hide resolved

:::info

The TypeScript examples from this page will only work as document if you import `jest` from `'@jest/globals'`:
Copy link
Member

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"?

Copy link
Contributor Author

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?

Copy link
Member

Choose a reason for hiding this comment

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

Reasonable 👍

@mrazauskas
Copy link
Contributor Author

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!

Yes, I was thinking about "What's New". That would work with version docs nicely as well. Will do it as separate PR.

@SimenB
Copy link
Member

SimenB commented Apr 18, 2022

Will make the blog post more of an highlights, which is nice. Prose for blog posts are always a pain 😅

@SimenB SimenB merged commit aa3692d into jestjs:main Apr 18, 2022
@mrazauskas mrazauskas deleted the docs-upgrade-guide branch April 18, 2022 19:04
@github-actions
Copy link

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.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants