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

[examples] Freeze examples dependency range #43435

Merged

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Aug 25, 2024

Make sure we can continue to easily run the examples on v5 once we release v6 as stable. This can help spot regressions. This is something that we used to care about, e.g. #28358.

Edit: oh annoying, the CI fails on the v5.x branch too, it's not specific to this PR. Fixing that in #43564

@oliviertassinari oliviertassinari added the examples Relating to /examples label Aug 25, 2024
@siriwatknp
Copy link
Member

siriwatknp commented Aug 27, 2024

To addon this, I think the README of the examples should be updated to point to v5.x too. For example:

diff --git a/examples/material-ui-cra-ts/README.md b/examples/material-ui-cra-ts/README.md
index dfd9da114d..dbb9c7cdbb 100644
--- a/examples/material-ui-cra-ts/README.md
+++ b/examples/material-ui-cra-ts/README.md
@@ -7,7 +7,7 @@ Download the example [or clone the repo](https://github.com/mui/material-ui):
 <!-- #default-branch-switch -->

 
 ## The idea behind the example
 
 This example demonstrates how you can use Material UI with [Create React App](https://github.com/facebookincubator/create-react-app) in [TypeScript](https://github.com/Microsoft/TypeScript).
 It includes `@mui/material` and its peer dependencies, including [Emotion](https://emotion.sh/docs/introduction), the default style engine in Material UI v6.
-If you prefer, you can [use styled-components instead](https://mui.com/material-ui/integrations/interoperability/#styled-components).
+If you prefer, you can [use styled-components instead](https://v5.mui.com/material-ui/integrations/interoperability/#styled-components).
 
 ## What's next?
 
 <!-- #default-branch-switch -->
 
 You now have a working example project.
-You can head back to the documentation and continue by browsing the [templates](https://mui.com/material-ui/getting-started/templates/) section.
+You can head back to the documentation and continue by browsing the [templates](https://v5.mui.com/material-ui/getting-started/templates/) section.

@zannager zannager requested a review from mnajdova August 27, 2024 15:03
@DiegoAndai DiegoAndai removed this from the Material UI: v6 milestone Aug 28, 2024
@DiegoAndai DiegoAndai added v5.x and removed v6.x labels Aug 28, 2024
Comment on lines 15 to 17
"react": "^18.0.0",
"react-dom": "^18.0.0",
"react-scripts": "^5.0.0"
Copy link
Member

Choose a reason for hiding this comment

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

I think we can use latest here, as we plan to bring the React 19 support to v5 too. @DiegoAndai what are your thoughts?

Copy link
Member Author

@oliviertassinari oliviertassinari Sep 5, 2024

Choose a reason for hiding this comment

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

Ah yeah, I didn't realize we were planning on bringing React 19 support to v5 when I created this PR. I assumed that because we released v6 before React 19 is stable, we wouldn't need to spend time on this. At least, I believe we fulfilled all the conditions to have React 19 only in v6 #42381 (comment).

Now, no real preferences on my end. I think https://tools-public.mui.com/prod/pages/npmVersion?package=@mui/material could tell us what's the best move. React 19 could help us consolidate the community on a single major.

Copy link
Member Author

@oliviertassinari oliviertassinari Sep 7, 2024

Choose a reason for hiding this comment

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

I'm reverting the "react" changes for now, it's fewer changes, it's never bad to scope down PRs 😄. It gives us more time to figure out the best move with React v19 on Material UI v5.

@oliviertassinari oliviertassinari merged commit daf961e into mui:v5.x Sep 7, 2024
19 checks passed
@oliviertassinari oliviertassinari deleted the prepare-v6-stable-release branch September 7, 2024 22:40
oliviertassinari added a commit that referenced this pull request Sep 7, 2024
oliviertassinari added a commit that referenced this pull request Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Relating to /examples v5.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants