Skip to content

Commit

Permalink
feat: upgrade to Gatsby v4
Browse files Browse the repository at this point in the history
Fix #773

BREAKING CHANGE: this version requires Gatsby v4 and gatsby-plugin-image v2
  • Loading branch information
browniebroke committed Oct 13, 2021
1 parent 6a121ad commit 2c92957
Show file tree
Hide file tree
Showing 5 changed files with 349 additions and 231 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ jobs:
fail-fast: false
matrix:
node_version:
- 12
- 14
- 16

steps:
- uses: actions/checkout@v2
Expand Down
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,17 @@ Very basic gallery grid based on `gatsby-plugin-image` and `react-image-lightbox
npm install --save @browniebroke/gatsby-image-gallery
```

Note: this library is compatible with Gatbsy v3 and `gatsby-plugin-image` as of version 6.
If you want to use it with Gastby v2 and the `gatsby-image` plugin, please stick to version 5 or earlier.
## Compatibility

Please check thw table below to choose the version of this library to use with your version of Gatsby:

| Gatsby Image Gallery | Gatsby | Gatsby Plugin Image | Gatsby Image |
| -------------------- | ------ | ------------------- | ------------- |
| v5 | v2 | Not supported | v3 |
| v6 | v3 | v1 | Not supported |
| v7 | v4 | v2 | Not supported |

Only the latest version of Gatsby Image Gallery is supported.

## Usage

Expand Down
18 changes: 9 additions & 9 deletions example/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
},
"dependencies": {
"babel-plugin-styled-components": "1.13.2",
"gatsby": "3.14.2",
"gatsby-plugin-image": "1.14.1",
"gatsby-plugin-manifest": "3.14.0",
"gatsby-plugin-react-helmet": "4.14.0",
"gatsby-plugin-sharp": "3.14.1",
"gatsby-plugin-styled-components": "4.14.0",
"gatsby-plugin-typescript": "3.14.0",
"gatsby-source-filesystem": "3.14.0",
"gatsby-transformer-sharp": "3.14.0",
"gatsby": "^4.0.0-zz-next.5",
"gatsby-plugin-image": "^2.0.0-zz-next.3",
"gatsby-plugin-manifest": "^4.0.0-zz-next.3",
"gatsby-plugin-react-helmet": "^5.0.0-zz-next.2",
"gatsby-plugin-sharp": "^4.0.0-zz-next.4",
"gatsby-plugin-styled-components": "^5.0.0-zz-next.2",
"gatsby-plugin-typescript": "^4.0.0-zz-next.3",
"gatsby-source-filesystem": "^4.0.0-zz-next.3",
"gatsby-transformer-sharp": "^4.0.0-zz-next.2",
"react": "17.0.2",
"react-dom": "17.0.2",
"react-helmet": "6.1.0",
Expand Down
6 changes: 3 additions & 3 deletions gatsby-image-gallery/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"src"
],
"engines": {
"node": ">=12.13"
"node": ">=14.15"
},
"scripts": {
"start": "tsdx watch",
Expand All @@ -27,7 +27,7 @@
"analyze": "size-limit --why"
},
"peerDependencies": {
"gatsby-plugin-image": "^1.0",
"gatsby-plugin-image": "^2.0",
"react": ">=16",
"styled-components": ">= 5.0"
},
Expand All @@ -42,7 +42,7 @@
"@types/react-test-renderer": "17.0.1",
"@types/styled-components": "5.1.15",
"babel-jest": "27.2.5",
"gatsby-plugin-image": "1.14.1",
"gatsby-plugin-image": "^2.0.0-zz-next.3",
"react": "17.0.2",
"react-dom": "17.0.2",
"react-test-renderer": "17.0.2",
Expand Down
Loading

0 comments on commit 2c92957

Please sign in to comment.