Skip to content

Release/1.2.54#1126

Merged
ttypic merged 2 commits intomainfrom
release/1.2.54
Jul 18, 2025
Merged

Release/1.2.54#1126
ttypic merged 2 commits intomainfrom
release/1.2.54

Conversation

@ttypic
Copy link
Copy Markdown
Contributor

@ttypic ttypic commented Jul 18, 2025

Release 1.2.54

Summary by CodeRabbit

  • Documentation

    • Updated version numbers in the changelog, contributing guide, and README to reference the latest 1.2.54 release.
    • Enhanced changelog with details on minor improvements and bug fixes for version 1.2.54.
  • Chores

    • Bumped internal version identifiers to 1.2.54 to reflect the latest release.
  • Tests

    • Updated test assertions to expect the new 1.2.54 version string.

@ttypic ttypic requested a review from sacOO7 July 18, 2025 11:06
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jul 18, 2025

Walkthrough

The changes update version references from 1.2.53 (or 1.2.22 in some documentation) to 1.2.54 across documentation, configuration, and a test file. The changelog is updated with a new entry for 1.2.54, and test assertions are adjusted to match the new version string. No functional code or API changes are present.

Changes

File(s) Change Summary
CHANGELOG.md Added a new entry for version 1.2.54, summarizing minor improvements and bug fixes.
CONTRIBUTING.md Updated AAR dependency version in documentation from 1.2.53 to 1.2.54.
README.md Updated Maven and Gradle dependency versions from 1.2.22/1.2.53 to 1.2.54 for SDK and OkHttp client.
gradle.properties Changed the version property from 1.2.53 to 1.2.54.
lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java Updated test assertion to expect the new version string "1.2.54".

Suggested reviewers

  • sacOO7

Poem

In the garden of code, a new version appears,
1.2.54 hops in, bringing cheers!
Docs and tests now sing in tune,
With numbers updated, none too soon.
The changelog grows, the carrots gleam—
Another bright patch in the rabbit’s dream! 🥕

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch release/1.2.54

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@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: 0

🧹 Nitpick comments (4)
CONTRIBUTING.md (1)

218-219: Avoid hard-coding the AAR filename

The snippet now embeds the literal version (1.2.54).
Using a placeholder (for example ably-android-${ABLY_VERSION}.aar) keeps the docs evergreen and avoids touch-ups every release.

lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java (1)

90-92: Hard-coded agent string makes the test brittle

Every version bump requires a manual patch here.
Consider deriving the expected value from the same constant used in production code, e.g.:

-Collections.singletonList("ably-java/1.2.54 jre/" + System.getProperty("java.version")));
+Collections.singletonList(
+    Defaults.ABLY_AGENT_VERSION + " jre/" + System.getProperty("java.version")));

This keeps the test self-maintaining across releases.

README.md (2)

54-55: Synchronise version string automatically

Similar to the earlier comment for CONTRIBUTING.md, embedding the literal version (1.2.54) means another manual edit next time.
If feasible, point readers to the Maven badge above or use a placeholder variable.


61-62: Gradle snippet – keep dependency line aligned

Minor: move the SLF4J line under the Ably dependency for readability or add a blank line between different groups.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 64a3acf and 3551836.

📒 Files selected for processing (5)
  • CHANGELOG.md (1 hunks)
  • CONTRIBUTING.md (1 hunks)
  • README.md (2 hunks)
  • gradle.properties (1 hunks)
  • lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java (1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings
Learnt from: sacOO7
PR: ably/ably-java#1095
File: gradle/libs.versions.toml:24-26
Timestamp: 2025-06-05T10:27:53.946Z
Learning: The ably-java project prefers to use the latest available versions of testing dependencies (including pre-release versions) when they contain relevant bug fixes, rather than sticking strictly to stable releases.
gradle.properties (1)
Learnt from: sacOO7
PR: ably/ably-java#1095
File: gradle/libs.versions.toml:24-26
Timestamp: 2025-06-05T10:27:53.946Z
Learning: The ably-java project prefers to use the latest available versions of testing dependencies (including pre-release versions) when they contain relevant bug fixes, rather than sticking strictly to stable releases.
lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java (1)
Learnt from: sacOO7
PR: ably/ably-java#1095
File: gradle/libs.versions.toml:24-26
Timestamp: 2025-06-05T10:27:53.946Z
Learning: The ably-java project prefers to use the latest available versions of testing dependencies (including pre-release versions) when they contain relevant bug fixes, rather than sticking strictly to stable releases.
CONTRIBUTING.md (1)
Learnt from: sacOO7
PR: ably/ably-java#1095
File: gradle/libs.versions.toml:24-26
Timestamp: 2025-06-05T10:27:53.946Z
Learning: The ably-java project prefers to use the latest available versions of testing dependencies (including pre-release versions) when they contain relevant bug fixes, rather than sticking strictly to stable releases.
README.md (3)
Learnt from: sacOO7
PR: ably/ably-java#1095
File: gradle/libs.versions.toml:24-26
Timestamp: 2025-06-05T10:27:53.946Z
Learning: The ably-java project prefers to use the latest available versions of testing dependencies (including pre-release versions) when they contain relevant bug fixes, rather than sticking strictly to stable releases.
Learnt from: sacOO7
PR: ably/ably-java#1095
File: live-objects/src/test/kotlin/io/ably/lib/objects/integration/setup/IntegrationTest.kt:87-89
Timestamp: 2025-06-06T09:28:12.298Z
Learning: The Sandbox.kt file in ably-java live-objects module already has comprehensive HTTP retry mechanism using HttpRequestRetry with 5 retries, exponential backoff, and automatic retry on non-success responses and timeout exceptions.
Learnt from: sacOO7
PR: ably/ably-java#1092
File: live-objects/src/test/kotlin/io/ably/lib/objects/TestUtils.kt:21-32
Timestamp: 2025-06-03T09:15:15.338Z
Learning: In test utility code for the Ably Java Live Objects module, the team prefers to keep reflection-based field access utilities simple without additional error handling, allowing tests to fail fast if incorrect field names are used.
CHANGELOG.md (1)
Learnt from: sacOO7
PR: ably/ably-java#1095
File: gradle/libs.versions.toml:24-26
Timestamp: 2025-06-05T10:27:53.946Z
Learning: The ably-java project prefers to use the latest available versions of testing dependencies (including pre-release versions) when they contain relevant bug fixes, rather than sticking strictly to stable releases.
🪛 markdownlint-cli2 (0.17.2)
README.md

58-58: Trailing punctuation in heading
Punctuation: ':'

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: check-rest
  • GitHub Check: check-realtime
  • GitHub Check: check-rest-okhttp
  • GitHub Check: check-liveobjects
  • GitHub Check: check-realtime-okhttp
  • GitHub Check: check (21)
  • GitHub Check: check (19)
  • GitHub Check: check (24)
  • GitHub Check: check (29)
  • GitHub Check: build
  • GitHub Check: check
🔇 Additional comments (3)
gradle.properties (1)

2-2: No stale version references detected – version bump to 1.2.54 is in sync

The VERSION_NAME in gradle.properties has been correctly updated to 1.2.54 and there are no remaining hard-coded occurrences of the previous 1.2.53 in the codebase (the only matches are in CHANGELOG.md, which intentionally reference past versions).
Defaults.ABLY_AGENT_VERSION derives from BuildConfig.VERSION (which pulls from gradle.properties), so the agent header will automatically use 1.2.54 at runtime.

CHANGELOG.md (1)

3-13: Changelog entry looks good

Entry follows existing format and links are correct.

README.md (1)

120-121: Runtime-only dependency version

Good catch updating the OkHttp runtime module; looks consistent with the main artifact.

Copy link
Copy Markdown
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 e6af916 into main Jul 18, 2025
13 checks passed
@ttypic ttypic deleted the release/1.2.54 branch July 18, 2025 15:12
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.

2 participants