v2.x to v3.x Migration Guide

This major release of this Gatsby theme moves Gatsby and all related Gatsby plugins and transformers from direct dependencies to peerDependencies so that consumers of this package can upgrade Gatsby without any intervention from Chord. This will require you to do more than just bump this version in the package.json.

Upgrade Guide

First, edit your package.json to remove @chordcommerce/gatsby-theme-performance and any of the package's peerDependencies from your dependencies list. We will be reinstalling them next. These peerDependencies are:

"@sentry/browser": ">=6.0.0",
"gatsby": "^4.4.0",
"gatsby-plugin-alias-imports": "^1.0.5",
"gatsby-plugin-image": "^2.4.0",
"gatsby-plugin-intl": "^0.3.3",
"gatsby-plugin-manifest": "^4.4.0",
"gatsby-plugin-netlify": "^4.2.0",
"gatsby-plugin-offline": "^5.4.0",
"gatsby-plugin-react-helmet": "^5.4.0",
"gatsby-plugin-robots-txt": "^1.6.14",
"gatsby-plugin-segment-js": "^3.7.1",
"gatsby-plugin-sharp": "^4.4.0",
"gatsby-plugin-sitemap": "^4.4.0",
"gatsby-react-router-scroll": "^4.4.0",
"gatsby-source-contentful": "^7.2.0",
"gatsby-transformer-inline-svg": "^1.2.0",
"gatsby-transformer-remark": "^5.4.0",
"gatsby-transformer-sharp": "^4.4.0",
"react": "^17.0.2",
"react-dom": "^17.0.2"

Then, run the following command in your shell:

$ npx install-peerdeps --yarn @chordcommerce/gatsby-theme-performance

If this command fails, npx will output an npm install/yarn add command that you can copy and run manually.

For more information and caveats around this, please read the installation instructions for this package.