Release/1.2.47

[ttypic]

Summary by CodeRabbit

• New Features

  • Introduced a manual release workflow to facilitate publishing to Maven Central.

• Bug Fixes

  • Added a note in the changelog regarding a fix for duplicate messages on rewind after version 1.2.34.

• Documentation

  • Updated CHANGELOG.md with new version entry and bug fix details.
  • Revised CONTRIBUTING.md for clearer development and release instructions.
  • Updated README.md with new dependency versions.

• Chores

  • Incremented version number in gradle.properties from 1.2.46 to 1.2.47.

[coderabbitai]

Walkthrough

A new GitHub Actions workflow named release.yaml has been added to facilitate manual releases to Maven Central. This workflow is triggered by a workflow_dispatch event and includes steps for validating the release, checking out code, setting up the JDK and Gradle, and publishing to Maven Central. Additionally, updates have been made to the CHANGELOG.md, CONTRIBUTING.md, README.md, and gradle.properties files to reflect the new version 1.2.47, along with clarifications in the contribution guidelines and dependency updates.

Changes

File	Change Summary
.github/workflows/release.yaml	New workflow added for manual releases to Maven Central with validation and publishing steps.
CHANGELOG.md	New version entry for 1.2.47 added, noting a bug fix for duplicate messages on rewind after 1.2.34.
CONTRIBUTING.md	Updated instructions for local usage, building AAR files, and refined release process guidance.
README.md	Dependency versions updated from 1.2.46 to 1.2.47 for Ably Java, Ably Android, and OkHttp libraries.
gradle.properties	Version name updated from 1.2.46 to 1.2.47.
lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java	Expected value updated in test to reflect new version 1.2.47.

Possibly related PRs

• Release/1.2.42 #1030: Updates to CHANGELOG.md for version 1.2.42, mentioning the introduction of workflow_dispatch.
• Release/1.2.43 #1038: Updates to CHANGELOG.md for version 1.2.43, including enhancements related to the release process.
• Release/1.2.44 #1044: Updates to CHANGELOG.md for version 1.2.44, documenting release processes relevant to the new workflow.
• Release/1.2.45 #1047: Updates to CHANGELOG.md for version 1.2.45, including changes related to the release process.
• Release/1.2.46 #1049: Updates to CHANGELOG.md for version 1.2.46, documenting the release process.

Suggested reviewers

• sacOO7
• AndyTWF

Poem

🐇 In the meadow, a new release,
Version 1.2.47 brings us peace.
With workflows set to publish right,
Our code takes flight, oh what a sight!
Hops of joy, we celebrate,
A brighter future, we create! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Experiment)
• @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.

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (2)

.github/workflows/release.yaml (2)

3-4: Consider adding inputs for version validation.

The workflow is manually triggered but doesn't validate if the version being released matches the tag. Consider adding workflow inputs to ensure version consistency.

 on:
   workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to release (e.g., 1.2.47)'
+        required: true
+        type: string

---

23-27: Consider caching JDK setup.

Add caching to speed up workflow execution and reduce GitHub Actions minutes usage.

 - name: Set up JDK
   uses: actions/setup-java@v4
   with:
     java-version: 17
     distribution: temurin
+    cache: 'gradle'

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6a2ec04 and 06cf9b7.

📒 Files selected for processing (6)

• .github/workflows/release.yaml (1 hunks)
• 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)

✅ Files skipped from review due to trivial changes (3)

• gradle.properties
• README.md
• CHANGELOG.md

🔇 Additional comments (2)

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

91-91: LGTM!

The version update in the test assertion correctly aligns with the new release version.

CONTRIBUTING.md (1)

222-222: LGTM!

The version update in the example code correctly aligns with the new release version.

[sacOO7]

LGTM