Skip to content

Conversation

ttypic
Copy link
Contributor

@ttypic ttypic commented Aug 22, 2025

What's Changed

Summary by CodeRabbit

  • Documentation
    • Added v2.0.13 entry to the changelog with a Full Changelog link.
    • Documented removal of await from a sync connect() call and an upgrade to the websockets dependency (supports Python 15+).
  • Chores
    • Bumped package/library version to 2.0.13.
    • No functional changes or public API modifications.

@ttypic ttypic requested a review from VeskeR August 22, 2025 18:21
Copy link

coderabbitai bot commented Aug 22, 2025

Walkthrough

Version bumped from 2.0.12 to 2.0.13 and changelog updated. No code or API changes beyond updating the version constant and package metadata.

Changes

Cohort / File(s) Summary of changes
Documentation
CHANGELOG.md
Added v2.0.13 entry with Full Changelog link and notes on removing await from sync connect() mention and upgrading websockets; documentation-only.
Version bump
ably/__init__.py, pyproject.toml
Updated lib_version and package version from 2.0.12 to 2.0.13; no other modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my whiskers—version hop!
From 12 to 13—quick little pop.
Changelog crumbs, neatly in a row,
No code burrows deeper below.
I thump approval: tidy, clean—
A carrot for v2.0.13! 🥕🐇

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ 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/2.0.13

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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

@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

🧹 Nitpick comments (1)
CHANGELOG.md (1)

3-10: Changelog entry reads well; minor nit — avoid bare URLs for PR links

Conform to prior entries and silence markdownlint MD034 by linking PR numbers explicitly.

Apply this diff:

-## What's Changed
-* Removed await from sync `connect()` function call by @kavindail in https://github.com/ably/ably-python/pull/605
-* Upgraded websockets dependency to support 15+ by @ttypic in https://github.com/ably/ably-python/pull/612
+## What's Changed
+* Removed await from sync `connect()` function call by @kavindail in [#605](https://github.com/ably/ably-python/pull/605)
+* Upgraded websockets dependency to support 15+ by @ttypic in [#612](https://github.com/ably/ably-python/pull/612)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between b165eb2 and 28ff3f8.

📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • ably/__init__.py (1 hunks)
  • pyproject.toml (1 hunks)
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md

[grammar] ~7-~7: There might be a mistake here.
Context: ...re/v2.0.12...v2.0.13) ## What's Changed * Removed await from sync connect() func...

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md

8-8: Bare URL used

(MD034, no-bare-urls)


9-9: Bare URL used

(MD034, no-bare-urls)

⏰ 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). (7)
  • GitHub Check: check (3.13)
  • GitHub Check: check (3.9)
  • GitHub Check: check (3.10)
  • GitHub Check: check (3.12)
  • GitHub Check: check (3.11)
  • GitHub Check: check (3.7)
  • GitHub Check: check (3.8)
🔇 Additional comments (1)
ably/__init__.py (1)

18-18: Approve lib_version bump to 2.0.13 — all versions are in sync

The numeric version in ably/__init__.py and pyproject.toml both resolve to 2.0.13, and there are no lingering references to 2.0.12.

• ably/init.py – lib_version = 2.0.13
• pyproject.toml – version = 2.0.13

To avoid matching file:line prefixes in future checks, you can use a more precise ripgrep invocation:

#!/usr/bin/env bash
set -euo pipefail

# Extract just the version number (no line/file prefixes)
v_init=$(rg -Po "lib_version\\s*=\\s*'\\K[^']+" ably/__init__.py | head -n1)
v_poetry=$(rg -Po 'version\\s*=\\s*"\\K[^"]+'   pyproject.toml    | head -n1)

echo "ably/__init__.py lib_version = $v_init"
echo "pyproject.toml version     = $v_poetry"

if [[ "$v_init" != "$v_poetry" ]]; then
  echo "ERROR: version mismatch"
  exit 1
fi

echo "No stale references to 2.0.12 found."

No API touchpoints here; safe change.

[tool.poetry]
name = "ably"
version = "2.0.12"
version = "2.0.13"
Copy link

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Poetry version set to 2.0.13 — LGTM

Straightforward metadata bump; aligns with ably/init.py.

If your release process expects a Git tag to back the CHANGELOG compare link, ensure a tag "v2.0.13" is pushed after merge:


🏁 Script executed:

#!/bin/bash
set -euo pipefail
echo "Intended tag: v$(rg -nUP '^[[:space:]]*version[[:space:]]*=[[:space:]]*"([^"]+)"' -or '$1' pyproject.toml | head -n1)"
# Example tagging (uncomment when ready):
# git tag -s "v$(rg -nUP '^[[:space:]]*version[[:space:]]*=[[:space:]]*"([^"]+)"' -or '$1' pyproject.toml | head -n1)" -m "Release $(date -I)"
# git push origin --tags

Length of output: 180


🏁 Script executed:

#!/bin/bash
set -euo pipefail
grep -n "__version__" ably/__init__.py

Length of output: 58


🏁 Script executed:

#!/bin/bash
set -euo pipefail
echo "Searching for version assignments in ably package"
rg -nP '(__version__|version)\s*=' --glob 'ably/**/*.py' || true

Length of output: 1883


Update release tagging snippet to correctly extract version

The existing example uses rg -nUP … -or '$1', which outputs 3:2.0.13 (including the line number) instead of the intended 2.0.13. Please update the snippet in the review comment as follows:

• pyproject.toml tagging example

  • Before:
    echo "Intended tag: v$(rg -nUP '^[[:space:]]*version\s*=\s*"([^"]+)"' -or '$1' pyproject.toml | head -n1)"
  • After:
    # Extracts just the version string (e.g. "2.0.13")
    TAG=v$(rg -Po '(?<=version\s*=\s*")[^"]+' pyproject.toml | head -n1)
    echo "Intended tag: $TAG"
    # Tag and push
    git tag -s "$TAG" -m "Release $TAG"
    git push origin "$TAG"

Version metadata in pyproject.toml now aligns with ably/__init__.py’s lib_version = '2.0.13'. Once merged, ensure the annotated tag v2.0.13 is created and pushed so that your CHANGELOG links resolve correctly.

🤖 Prompt for AI Agents
pyproject.toml lines 3-3: the release-tagging example in the review comment
needs to be replaced so it extracts only the version string (no line numbers)
and then creates/pushes an annotated tag; update the snippet to use ripgrep with
a Perl regex lookbehind to capture the value inside the version quotes, pipe to
head -n1, prefix with "v" into a TAG variable, echo the intended tag, create a
signed annotated tag with that TAG and message "Release $TAG", and push the tag
to origin.

@ttypic ttypic merged commit 5007cb6 into main Aug 22, 2025
3 of 10 checks passed
@ttypic ttypic deleted the release/2.0.13 branch August 22, 2025 19:52
Copy link
Contributor

@VeskeR VeskeR left a comment

Choose a reason for hiding this comment

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

LGTM

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