Skip to content

Conversation

@ttypic
Copy link
Contributor

@ttypic ttypic commented Jan 21, 2026

What's Changed

Summary by CodeRabbit

  • Documentation

    • Added a detailed v1.6.0 changelog summarizing REST, Realtime, and Migration guidance, including behavioral and async adjustments.
    • Updated installation and dependency docs to reference v1.6.0.
  • Chores

    • Bumped project version to 1.6.0.
  • Tests

    • Updated tests to expect the new library version in runtime metadata.

✏️ Tip: You can customize this high-level summary in your review settings.

@ttypic ttypic requested a review from sacOO7 January 21, 2026 01:13
@coderabbitai
Copy link

coderabbitai bot commented Jan 21, 2026

Walkthrough

Adds a 1.6.0 release: updates version references, adds a changelog entry describing experimental Mutable Message REST and Realtime behavior changes and migration guidance, and updates a test expectation to the new agent version.

Changes

Cohort / File(s) Summary
Build Configuration & Docs
gradle.properties, CONTRIBUTING.md, README.md
Bumps VERSION_NAME and example dependency references from 1.5.0 to 1.6.0.
Release Documentation
CHANGELOG.md
Adds a new 1.6.0 release section documenting experimental Mutable Message features, REST API result/async semantics and append ops, Realtime async mutation transport/optional callbacks, and a migration guide.
Tests
lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java
Updates expected agent header string to ably-java/1.6.0.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped to 1.6 with a joyful spin,
Changelog sprouted where changes begin,
Docs and props nudged to the newer name,
A test updated to match the same,
🥕 Experimental hops — small but spry!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Release/1.6.0' directly describes the main objective of the pull request: bumping the package version to 1.6.0. All file changes (CHANGELOG.md, gradle.properties, README.md, CONTRIBUTING.md, and test files) consistently reflect this version bump.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release/1.6.0

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot temporarily deployed to staging/pull/1185/features January 21, 2026 01:14 Inactive
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Line 28: Fix the grammatical error in the CHANGELOG entry referencing
updateMessage(), deleteMessage(), and appendMessage(): change "are now use
WebSocket transport to send data rather than REST requests" to "now use
WebSocket transport to send data rather than REST requests" so the sentence
reads correctly while keeping the function names and meaning unchanged.

@github-actions github-actions bot temporarily deployed to staging/pull/1185/javadoc January 21, 2026 01:16 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1185/features January 21, 2026 01:17 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/1185/javadoc January 21, 2026 01:19 Inactive
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Around line 9-11: The CHANGELOG contains bare URLs that trigger markdownlint
MD034; update each bare link (e.g., the URLs for PRs
"https://github.com/ably/ably-java/pull/1182",
"https://github.com/ably/ably-java/pull/1183", and
"https://github.com/ably/ably-java/pull/1184") to use inline markdown link
syntax (for example replace the raw URL with a descriptive link like
[`#1182`](https://github.com/ably/ably-java/pull/1182) or [Message Updates and
Deletes PR](https://github.com/ably/ably-java/pull/1182)) so the changelog lines
read without bare URLs and satisfy MD034.
♻️ Duplicate comments (1)
CHANGELOG.md (1)

28-28: Fix grammar: “are now use” → “now use”.
This is already flagged in a previous review; please apply the suggested wording.

📝 Proposed fix
-* `updateMessage()`, `deleteMessage()`, and `appendMessage()` are now use WebSocket transport to send data rather than REST requests
+* `updateMessage()`, `deleteMessage()`, and `appendMessage()` now use WebSocket transport to send data rather than REST requests

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Around line 32-43: Update the "Before (v1.5.0)" example to use the original
CompletionListener type and its parameterless onSuccess signature instead of
Callback<UpdateDeleteResult>; specifically change the callback passed to
channel.updateMessageAsync in the before-example from
Callback<UpdateDeleteResult> to CompletionListener and ensure the onSuccess
method has no parameters (add `@Override` if presentationally desired) so the
example matches the described migration from CompletionListener to
Callback<UpdateDeleteResult>.
- Around line 45-56: The "Before (v1.5.0)" examples incorrectly show
Callback<UpdateDeleteResult> instead of the previous CompletionListener; update
both REST and Realtime "Before" snippets to use CompletionListener (e.g.,
channel.updateMessageAsync(..., new CompletionListener() { public void
onSuccess() { ... } })) and ensure the "After (v1.6.0)" examples remain using
Callback<UpdateDeleteResult> (e.g., channel.updateMessage or
channel.updateMessageAsync with Callback<UpdateDeleteResult> and
onSuccess(UpdateDeleteResult result)).

Copy link
Collaborator

@sacOO7 sacOO7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ttypic ttypic merged commit c2e5a7f into main Jan 21, 2026
13 of 14 checks passed
@ttypic ttypic deleted the release/1.6.0 branch January 21, 2026 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants