Skip to content

Commit 252e90c

Browse files
authored
chore: setup workflow and improve migration guide for v6 rc release (#2727)
1 parent 8f4ca60 commit 252e90c

File tree

7 files changed

+28
-24
lines changed

7 files changed

+28
-24
lines changed

.github/workflows/check-pr.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
branches:
66
- develop
77
- main
8+
- v6.0.0
89
- 'v[0-9]+.[0-9]+.[0-9]+*beta*'
910
types: [opened, synchronize]
1011

.github/workflows/docusaurus.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ on:
55
branches:
66
- main # default branch name for each repo that docs should be push from
77
- develop
8+
- v6.0.0
89
env:
9-
branch_map: '{"refs/heads/main": "production", "refs/heads/develop": "staging"}'
10+
branch_map: '{"refs/heads/main": "production", "refs/heads/develop": "staging", "refs/heads/v6.0.0": "production"}'
1011
jobs:
1112
push_docusaurus:
1213
runs-on: ubuntu-latest

.github/workflows/next-release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches:
66
- develop
7+
- v6.0.0
78

89
jobs:
910
publish-next:

.github/workflows/sdk-size-metrics.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99
branches:
1010
- develop
1111
- main
12+
- v6.0.0
1213

1314
env:
1415
HOMEBREW_NO_INSTALL_CLEANUP: 1 # Disable cleanup for homebrew, we don't need it on CI

docusaurus/docs/reactnative/basics/migrating-from-5.x-to-6.x.mdx

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,11 @@ id: upgrading-from-v5
33
title: Migration from 5.x to 6.x
44
---
55

6-
:::note
7-
If you are using new architecture or the new FlatList with [`maintainVisibleContentPosition`](https://reactnative.dev/docs/scrollview#maintainvisiblecontentposition) feat, v6.0 would require you to be in React native version **0.72** and above.
8-
:::
9-
106
## Dependency changes
117

128
The following are the crucial changes of the Stream Chat React Native SDK from version 5.x to 6.x:
139

14-
#### Change `react-native-fs` to `react-native-blob-util`
10+
### Change `react-native-fs` to `react-native-blob-util`
1511

1612
The `react-native-fs` package has been replaced to `react-native-blob-util` in favour of the former not being actively maintained. You can replace it by running the following commands:
1713

@@ -20,7 +16,7 @@ yarn remove react-native-fs
2016
yarn add react-native-blob-util
2117
```
2218

23-
#### Change `react-native-image-resizer` to `@bam.tech/react-native-image-resizer`
19+
### Change `react-native-image-resizer` to `@bam.tech/react-native-image-resizer`
2420

2521
The `react-native-image-resizer` package has been replaced with `@bam.tech/react-native-image-resizer`.
2622

@@ -33,7 +29,7 @@ yarn remove react-native-image-resizer
3329
yarn add @bam.tech/react-native-image-resizer
3430
```
3531

36-
#### Change `react-native-image-crop-picker` to `react-native-image-picker`
32+
### Change `react-native-image-crop-picker` to `react-native-image-picker`
3733

3834
The `react-native-image-crop-picker` package has been replaced with `react-native-image-picker`. This is a better alternative, and can help us with our new architecture endeavors.
3935

@@ -46,7 +42,7 @@ yarn add react-native-image-picker
4642

4743
Also, the dependency is made optional now, so if you don't want to use the image picker, you can remove it from your project and the camera selector icon on the Attachment picker will be simply hidden for you.
4844

49-
#### Change `react-native-quick-sqlite` to `op-sqlite`
45+
### Change `react-native-quick-sqlite` to `op-sqlite`
5046

5147
The `react-native-quick-sqlite` package has been replaced with `op-sqlite`. This is a faster alternative, and can help us with our new architecture endeavors.
5248

@@ -57,7 +53,7 @@ yarn remove react-native-quick-sqlite
5753
yarn add op-sqlite
5854
```
5955

60-
#### Made `@stream-io/flat-list-mvcp` optional
56+
### Made `@stream-io/flat-list-mvcp` optional
6157

6258
The dependency on `@stream-io/flat-list-mvcp` package has been made optional in favour of React Native's [`FlatList`](https://reactnative.dev/docs/flatlist) component supporting [`maintainVisibleContentPosition`](https://reactnative.dev/docs/scrollview#maintainvisiblecontentposition) from React Native version `>=0.72`. If the package is installed it takes up the package or the default React Native [`FlatList`](https://reactnative.dev/docs/flatlist).
6359

@@ -72,7 +68,7 @@ yarn remove @stream-io/flat-list-mvcp
7268

7369
## SDK changes
7470

75-
#### Introduce new Message Menu design
71+
### Introduce new Message Menu design
7672

7773
The Message Menu design has been revamped to provide a better user experience. The new design is more intuitive and provides a better user experience.
7874

@@ -82,7 +78,7 @@ The Message Menu design has been revamped to provide a better user experience. T
8278
The previous overlay design has been replaced with a bottom sheet modal design.
8379
:::
8480

85-
#### Introduce new ReactionList design
81+
### Introduce new ReactionList design
8682

8783
We have introduced a new ReactionList design that is more intuitive and provides a better user experience.
8884

@@ -120,11 +116,11 @@ const App = () => {
120116
If nothing is provided, the `resizableCDNHosts` will default to `['.stream-io-cdn.com']`.
121117
:::
122118

123-
#### Removed `MessageOverlayContext` and `MessageOverlayProvider`
119+
### Removed `MessageOverlayContext` and `MessageOverlayProvider`
124120

125121
The `MessageOverlayContext` and `MessageOverlayProvider` have been removed.
126122

127-
#### Removed props from `OverlayProvider`
123+
### Removed props from `OverlayProvider`
128124

129125
The following props have been removed from the `OverlayProvider`:
130126

@@ -136,7 +132,7 @@ The following props have been removed from the `OverlayProvider`:
136132
- `messageTextNumberOfLines`
137133
- `error`, `isMyMessage`, `isThreadMessage`, `message` and `messageReactions`
138134

139-
#### New `Channel` props
135+
### New `Channel` props
140136

141137
The props from the `OverlayProvider` have been moved to the `Channel` component. The following props have been added to the `Channel` component:
142138

@@ -147,7 +143,7 @@ The props from the `OverlayProvider` have been moved to the `Channel` component.
147143
- `OverlayReactionsItem` is changed to `MessageUserReactionsItem`
148144
- `messageTextNumberOfLines`
149145

150-
#### Removed `MessageOverlay` in favour of `MessageMenu`.
146+
### Removed `MessageOverlay` in favour of `MessageMenu`.
151147

152148
The `MessageOverlay` component has been removed in favour of `MessageMenu`. The `MessageMenu` component is a more versatile and feature-rich component that can be used to show more than just reactions and actions.
153149

@@ -165,7 +161,7 @@ The following props have been removed from the `Message` component:
165161

166162
The later 3 props are removed in favour of similar props on MessagesContext and is therefore not needed. The `setData` prop is removed in favour of the removal of `MessageOverlayContext` and the `setOverlay` is not needed as we don't set the message overlay in `OverlayProvider`.
167163

168-
#### Removed props from `MessageContent` component
164+
### Removed props from `MessageContent` component
169165

170166
The following props have been removed from the `MessageContent` component:
171167

@@ -175,18 +171,18 @@ The following props have been removed from the `MessageContent` component:
175171

176172
The props were redundant as per the new fixes in the Reaction Design and message simple component's improvements.
177173

178-
#### Add props to `MessageSimple` component
174+
### Add props to `MessageSimple` component
179175

180176
The components from the `MessageContent` components are rendered now in `MessageSimple` component so few of the props that were removed from `MessageContent` are added to `MessageSimple` component(as mentioned above).
181177

182178
- `isMyMessage`, `lastGroupMessage`, `members`, `onlyEmojis`, `otherAttachments`, `showMessageStatus` imported from the Message Context.
183179
- `MessageDeleted`, `MessageFooter`, `MessageHeader`, `MessagePinnedHeader`, `MessageReplies`, `MessageStatus`, `ReactionListBottom`, `reactionListPosition` and `ReactionListTop` imported from the Messages Context.
184180

185-
#### Added `BottomSheetModal` component
181+
### Added `BottomSheetModal` component
186182

187183
The version introduces a very basic `BottomSheetModal` component that can be used to show a modal at the bottom of the screen. This can be used to show the message actions and reactions.
188184

189-
#### Remove `NetInfo` from the native handlers
185+
### Remove `NetInfo` from the native handlers
190186

191187
The `NetInfo` package has been removed from the native handlers. This also involves not passing the `NetInfo` utility as a handler to [`registerNativeHandlers`](../customization/native-handlers.mdx#overriding-handlers) anymore.
192188

@@ -199,15 +195,15 @@ registerNativeHandlers({
199195
});
200196
```
201197

202-
#### Change the type of `quotedMessage` in `MessageInputContext`
198+
### Change the type of `quotedMessage` in `MessageInputContext`
203199

204200
The type of `quotedMessage` is changed from `MessageType | boolean` to `MessageType | undefined` for better in the `MessageInputContext`.
205201

206-
#### Refactor of theme object
202+
### Refactor of theme object
207203

208204
The default theme object has been refactored to provide a better customization experience. The theme object is now more organized and provides better control over the customization. You can check the object [here](https://github.com/GetStream/stream-chat-react-native/blob/develop/package/src/contexts/themeContext/utils/theme.ts).
209205

210-
#### Remove the deprecated code
206+
### Remove the deprecated code
211207

212208
- We have removed `loadChannelAtMessage` from channel context because it was no more used.
213209
- We have removed the `handleDeleteMessage`, `handleEditMessage`, `handleQuotedReplyMessage`, `handleResendMessage`, `handleToggleBanUser` and `handleToggleMuteUser` from the message context because it was no more used. To customize the message actions follow the [customization documentation](../guides/custom-message-actions.mdx).

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
"scripts": {
2929
"lerna-workspaces": "lerna",
3030
"release": "yarn lerna-workspaces run release",
31-
"release-rc": "yarn lerna-workspaces run release-rc",
3231
"release-next": "yarn lerna-workspaces run release-next",
3332
"extract-changelog": "rm -rf NEXT_RELEASE_CHANGELOG.md && yarn lerna-workspaces run extract-changelog",
3433
"bootstrap": "yarn lerna-workspaces run bootstrap",

release/next.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ configPromise.then((config) => {
1313
channel: 'beta',
1414
prerelease: 'beta',
1515
},
16+
{
17+
name: 'v6.0.0',
18+
channel: 'rc',
19+
prerelease: 'rc',
20+
},
1621
],
1722
}).then((result) => {
1823
// This logics avoid a overflow of next tags in github by removing the last

0 commit comments

Comments
 (0)