Skip to content

Commit 79072bb

Browse files
authored
docs: adds verbosity to initial v9 migration steps (#1922)
1 parent 53653fe commit 79072bb

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/migration.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,16 @@ completely removed.
1313

1414
The theme object, along with its utility functions, introduce a minimal set of
1515
breaking changes for Garden version 9. It is important to proceed with caution
16-
when upgrading each Garden package individually. All existing v8 packages must
17-
be
18-
[v8.75.0](https://github.com/zendeskgarden/react-components/releases/tag/v8.75.0)
19-
or higher in order to complete a successful individual package migration to v9.
20-
Detailed theming change instructions are provided under the
21-
[@zendeskgarden/react-theming](#zendeskgardenreact-theming) package.
16+
when upgrading each Garden package individually.
17+
18+
To begin a v9 migration, these initial steps must be taken before upgrading individual packages:
19+
20+
- All existing v8 packages must be set to
21+
[v8.75.0](https://github.com/zendeskgarden/react-components/releases/tag/v8.75.0)
22+
or higher in order to complete a successful individual package migration to v9.
23+
- Since `@zendeskgarden/react-theming` is central to all Garden packages, it must be
24+
updated to v9 first. Detailed theming upgrade instructions are provided under the
25+
[breaking changes section](#zendeskgardenreact-theming).
2226

2327
Garden has transitioned from utilizing [Popper](https://popper.js.org/docs/) to
2428
adopting the enhanced [Floating UI](https://floating-ui.com/) library. In the
@@ -40,15 +44,13 @@ consider additional positioning prop support on a case-by-case basis.
4044
- `react-theming@v9` uses version range `^4.2.0 || ^5.3.1` to support `v8` to `v9` upgrades.
4145

4246
- Garden v9 upgraded from `react-merge-refs` v1 to v2.
43-
4447
- The [breaking
4548
change](https://github.com/gregberge/react-merge-refs/blob/main/CHANGELOG.md#200-2022-06-19)
4649
exports ESM only.
4750
- Build and test pipelines may need to be updated to account for the `.mjs`
4851
extension. See Garden's
4952
[jest.config.js](https://github.com/zendeskgarden/react-components/blob/c2aa97d1edccfa0578ee5655b543ca6635767fb9/utils/test/jest.config.js#L28-L30)
5053
for details.
51-
5254
- The following breaking changes are listed alphabetically by package. While
5355
individual packages can be upgraded one at a time,
5456
[@zendeskgarden/react-theming](#zendeskgardenreact-theming) must be upgraded

0 commit comments

Comments
 (0)