[CHA-2585] feat: add migration guide from stream-chat-java#45
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a new documentation section to help developers migrate from the legacy stream-chat-java SDK to stream-sdk-java, with topic-based guides and side-by-side code examples.
Changes:
- Introduces a new migration guide hub (
docs/migration-from-stream-chat-java/README.md) plus per-topic guides (setup/auth, users, channels, messages/reactions, moderation, devices). - Adds a link from the repository root
README.mdto the new migration guide.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/migration-from-stream-chat-java/README.md | Landing page summarizing key differences and linking to topic guides |
| docs/migration-from-stream-chat-java/01-setup-and-auth.md | Setup/auth migration instructions (deps, initialization, tokens, sub-clients) |
| docs/migration-from-stream-chat-java/02-users.md | User operation migrations (upsert/query/partial update/deactivate/delete) |
| docs/migration-from-stream-chat-java/03-channels.md | Channel operation migrations (create/query/update/members/delete/truncate) |
| docs/migration-from-stream-chat-java/04-messages-and-reactions.md | Message & reaction operation migrations (send/get/update/delete/replies/reactions) |
| docs/migration-from-stream-chat-java/05-moderation.md | Moderation operation migrations (moderators, ban/unban, mute/unmute, query banned) |
| docs/migration-from-stream-chat-java/06-devices.md | Device management migrations (create/list/delete, APN/FCM/VoIP) |
| README.md | Adds an entry-point link to the migration guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```xml | ||
| <dependency> | ||
| <groupId>io.getstream</groupId> | ||
| <artifactId>stream-chat-java</artifactId> | ||
| <version>LATEST</version> | ||
| </dependency> | ||
| ``` |
There was a problem hiding this comment.
The installation snippets use LATEST as the dependency version. Maven/Gradle don’t reliably support this and it encourages unpinned builds; the repo README uses a $streamVersion placeholder instead. Please replace LATEST with a concrete version (or the same placeholder used in the main README) so the example is copy/paste-safe.
| Gradle: | ||
| ```groovy | ||
| implementation 'io.getstream:stream-chat-java:LATEST' | ||
| ``` |
There was a problem hiding this comment.
The Gradle snippets use LATEST as the dependency version. Please replace this with a pinned version (or the same $streamVersion placeholder used in the repo README) so builds are reproducible and the examples are copy/paste-safe.
| var response = client.chat().getMessage("message-id", | ||
| GetMessageRequest.builder() | ||
| .showDeletedMessage(true) | ||
| .build()) |
There was a problem hiding this comment.
GetMessageRequest doesn’t have a Lombok builder setter named showDeletedMessage(...) in this repo: the generated field is ShowDeletedMessage (capital S), so Lombok generates a builder method ShowDeletedMessage(Boolean). As written, this example won’t compile; please update the snippet to use the actual builder method name (or adjust the request model/generator so the field follows normal lowerCamelCase).
Note
Low Risk
Documentation-only change: adds migration docs and a README link, with no runtime or API behavior changes.
Overview
Adds a
stream-chat-javamigration guide underdocs/migration-from-stream-chat-java/, with topic-based pages providing side-by-side code examples for setup/auth, users, channels, messages/reactions, moderation, and device management.Updates
README.mdto point existingstream-chat-javausers to the new guide.Written by Cursor Bugbot for commit e589217. This will update automatically on new commits. Configure here.