Release 1.2.22

[surminus]

Updated CHANGELOG using the changelog generator, but do we need a comment in here about the endpoint option?

Summary by CodeRabbit

• Documentation
  • Introduced version 1.2.22 in the changelog, including a summary of enhancements and resolved issues with relevant links.
• Chores
  • Updated the library version to 1.2.22 to reflect recent improvements and fixes.

[coderabbitai]

Walkthrough

This pull request updates the project version to 1.2.22. A new section is added in the CHANGELOG.md document that includes a link to the full changelog, enhancements, and a closed issue related to a failing test. The constant clientLibraryVersion in ably/proto_http.go is updated from "1.2.21" to "1.2.22", reflecting these version changes.

Changes

File	Change Summary
CHANGELOG.md	Added new section for version 1.2.22 with a link to the full changelog, enhancement for endpoint client option, and a closed issue entry (#678).
ably/proto_http.go	Updated the clientLibraryVersion constant from "1.2.21" to "1.2.22".

Possibly related PRs

• Release/1.2.21 #672: Relates to updating the clientLibraryVersion constant, showing a progression from earlier version documentation.
• Release/1.2.20 #670: Involves a similar update in the version constant, indicating a sequential versioning process.

Suggested reviewers

• ttypic

Poem

I'm a rabbit, swift and keen,
Skipping through the code so green.
New version hops in, light and spry,
With fixes and updates, oh my!
Celebrating changes under a bright tech sky.
ASCII carrots for days!
🥕🐇

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cb41346 and 9f8af12.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• ably/proto_http.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• ably/proto_http.go

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: integration-test (1.22, msgpack)
• GitHub Check: integration-test (1.22, json)
• GitHub Check: integration-test (1.21, msgpack)
• GitHub Check: integration-test (1.21, json)
• GitHub Check: integration-test (1.20, msgpack)
• GitHub Check: integration-test (1.20, json)
• GitHub Check: integration-test (1.19, msgpack)
• GitHub Check: integration-test (1.19, json)

🔇 Additional comments (4)

CHANGELOG.md (4)

7-9: Enhancement Entry Meets Previous Suggestions
The enhancement entry clearly states:
- Added support for endpoint clientOption, marked other related options as deprecated [#679](https://github.com/ably/ably-go/pull/679)
This directly addresses sacOO7’s prior suggestion, and the wording is appropriate.

---

11-13: Closed Issues Entry is Clear and Accurate
The entry under "Closed issues" for fixing the failing test (i.e. Fix failing test TestRealtime_RTN17_Integration_HostFallback_Timeout [#678]) is clearly formatted and accurately reflects the changes. No modifications are needed here.

---

3-3: 🛠️ Refactor suggestion

Ensure Consistent Version Tagging in Header
The header for version 1.2.22 uses the URL https://github.com/ably/ably-go/tree/v.1.2.22 with an extra dot after "v" compared to the previous version’s URL (which is v1.2.21). For consistency, consider using v1.2.22 (without the dot) to match the established pattern.

---

5-5: 🛠️ Refactor suggestion

Verify Consistency in the Full Changelog Link
The "Full Changelog" link currently shows https://github.com/ably/ably-go/compare/v1.2.21...v.1.2.22. Ensure that the version tags used here are consistent with the header (i.e. both should use v1.2.22) to avoid confusion.

---

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. (Beta)
• @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: 0

🧹 Nitpick comments (1)

CHANGELOG.md (1)

3-10: New Version Section for 1.2.22 is Well-Formatted

The new section for version 1.2.22 is clearly added with an appropriate header, a link to the full changelog, and an entry for the closed issue. There is no comment about an "endpoint option" here. If the endpoint option is an internal detail that does not affect end users, its omission seems acceptable. However, if recent changes related to the endpoint option could impact consumers (e.g., requiring configuration changes or impacting integration), then consider adding a brief note. Otherwise, the current information is sufficient.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ce58fa3 and cb41346.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• ably/proto_http.go (1 hunks)

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

• ably/proto_http.go

⏰ Context from checks skipped due to timeout of 90000ms (8)

• GitHub Check: integration-test (1.22, msgpack)
• GitHub Check: integration-test (1.22, json)
• GitHub Check: integration-test (1.21, msgpack)
• GitHub Check: integration-test (1.21, json)
• GitHub Check: integration-test (1.20, msgpack)
• GitHub Check: integration-test (1.20, json)
• GitHub Check: integration-test (1.19, msgpack)
• GitHub Check: integration-test (1.19, json)

[sacOO7]

LGTM
Just need to update CHANGELOG a bit