chore(docs): clarify react upgrade with --legacy-peer-deps (#38359)

gatsbyjs · Jul 21, 2023 · 2e08202 · 2e08202
1 parent e5126f9
commit 2e08202
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/docs/reference/release-notes/migrating-from-v4-to-v5.md b/docs/docs/reference/release-notes/migrating-from-v4-to-v5.md
@@ -77,6 +77,12 @@ Or run
 npm install react@latest react-dom@latest
 ```
 
+Please note: If you use npm 7 or higher you'll want to use the `--legacy-peer-deps` option when following the instructions in this guide. For example, the above command would be:
+
+```shell
+npm install react@latest react-dom@latest --legacy-peer-deps
+```
+
 ### Update Gatsby related packages
 
 Update your `package.json` to use the `latest` version for all Gatsby related packages. You should upgrade any package name that starts with `gatsby-*`. Note that this only applies to plugins managed in the [gatsbyjs/gatsby](https://github.com/gatsbyjs/gatsby) repository. All packages we manage received a major version bump. Community plugins may not be upgraded yet so please check their repository for the current status.