Release v2.11.0#2069
Merged
Merged
Conversation
WalkthroughVersion updated to 2.11.0 across package metadata and React hooks export; CHANGELOG updated with a new release entry noting LiveMap JSON-encodable object support. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ Finishing Touches
🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (3)
CHANGELOG.md(1 hunks)package.json(1 hunks)src/platform/react-hooks/src/AblyReactHooks.ts(1 hunks)
⏰ 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: test-browser (chromium)
- GitHub Check: test-node (16.x)
- GitHub Check: test-browser (firefox)
- GitHub Check: test-node (20.x)
- GitHub Check: test-browser (webkit)
- GitHub Check: test-node (18.x)
- GitHub Check: test-npm-package
🔇 Additional comments (3)
package.json (1)
4-4: Version bump to 2.11.0 looks good.Matches the release intent and related changes. No issues spotted here.
CHANGELOG.md (1)
5-8: Changelog entry for 2.11.0 looks correct and concise.Release date, tag link, and PR reference are consistent with the version bump.
src/platform/react-hooks/src/AblyReactHooks.ts (1)
15-15: React Hooks version constant updated to 2.11.0 — agent string will correctly emit react-hooks/2.11.0.Change is minimal and correct.
| export type ChannelParameters = string | ChannelNameAndOptions; | ||
|
|
||
| export const version = '2.10.1'; | ||
| export const version = '2.11.0'; |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify all version surfaces are synchronized (no lingering 2.10.1, and subpackage manifests match).
To avoid version drift in published artifacts and Ably-Agent headers, verify:
- No remaining references to 2.10.1 exist.
- The React Hooks version constant matches package.json.
- The react subpackage manifests used during build are aligned.
Run this script from repo root:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "1) Comparing package.json version with AblyReactHooks.ts constant..."
PKG_VERSION=$(jq -r '.version' package.json)
HOOKS_FILE="src/platform/react-hooks/src/AblyReactHooks.ts"
if [ ! -f "$HOOKS_FILE" ]; then
echo "ERROR: $HOOKS_FILE not found"; exit 2
fi
HOOKS_VERSION=$(sed -nE "s/^\s*export const version = '([^']+)';/\1/p" "$HOOKS_FILE" | head -n1)
echo "package.json: $PKG_VERSION"
echo "AblyReactHooks.ts: ${HOOKS_VERSION:-<not found>}"
test -n "$HOOKS_VERSION" || { echo "ERROR: Could not extract version from $HOOKS_FILE"; exit 3; }
if [ "$PKG_VERSION" != "$HOOKS_VERSION" ]; then
echo "ERROR: Version mismatch (package.json=$PKG_VERSION, AblyReactHooks.ts=$HOOKS_VERSION)"; exit 4
fi
echo
echo "2) Checking React subpackage manifest templates used by build (res/)..."
RES_DIR="src/platform/react-hooks/res"
if [ -d "$RES_DIR" ]; then
MISMATCH=0
while IFS= read -r -d '' f; do
v=$(jq -r '.version // empty' "$f" 2>/dev/null || true)
if [ -n "$v" ]; then
printf "%s -> version=%s\n" "$f" "$v"
if [ "$v" != "$PKG_VERSION" ]; then
echo "WARN: Version mismatch in $f (expected $PKG_VERSION)"
MISMATCH=1
fi
fi
done < <(fd -0 -a 'package.*.json' "$RES_DIR")
if [ "$MISMATCH" -ne 0 ]; then
echo "ERROR: One or more res package.*.json versions do not match $PKG_VERSION"; exit 5
fi
else
echo "NOTE: $RES_DIR not found; skipping res manifests check."
fi
echo
echo "3) Scanning for lingering references to previous version (2.10.1)..."
if rg -n "\b2\.10\.1\b" -g '!**/node_modules/**' -g '!**/dist/**' -g '!**/build/**'; then
echo "ERROR: Found lingering references to 2.10.1 (see matches above)"; exit 6
else
echo "OK: No lingering references to 2.10.1 found."
fi
echo
echo "All version checks passed."Length of output: 1072
🏁 Script executed:
#!/usr/bin/env bash
set -euo pipefail
echo "Verifying React Hooks subpackage manifests..."
RES_DIR="src/platform/react-hooks/res"
PKG_VERSION=$(jq -r .version package.json)
if [ -d "$RES_DIR" ]; then
files=$(find "$RES_DIR" -type f -name 'package.*.json')
if [ -z "$files" ]; then
echo "No manifest templates found in $RES_DIR"
else
for f in $files; do
v=$(jq -r '.version // empty' "$f" 2>/dev/null)
echo "$f -> version=${v:-<none>}"
if [ -n "$v" ] && [ "$v" != "$PKG_VERSION" ]; then
echo "ERROR: Version mismatch in $f (expected $PKG_VERSION, got $v)"
exit 1
fi
done
fi
else
echo "NOTE: $RES_DIR not found; skipping res manifests check."
fi
echo
echo "Scanning for lingering 2.10.1 references..."
if rg -n '\b2\.10\.1\b' -g '!**/node_modules/**' -g '!**/dist/**' -g '!**/build/**'; then
echo "ERROR: Found lingering references to 2.10.1"
exit 1
else
echo "OK: No lingering 2.10.1 references found."
fi
echo
echo "Verification complete."Length of output: 1764
Align React-Hooks subpackage manifests and update CHANGELOG for v2.11.0
- src/platform/react-hooks/res/package.cjs.json, package.mjs.json, package.react.json
• Add a"version": "2.11.0"field to each manifest so they match package.json. - CHANGELOG.md
• Insert a new## [2.11.0] – YYYY-MM-DDrelease heading (with your release notes) above the existing## [2.10.1]section.
• This ensures there are no stale 2.10.1 references at the top level. - Verified:
• package.json and AblyReactHooks.ts both export version 2.11.0.
🤖 Prompt for AI Agents
In src/platform/react-hooks/src/AblyReactHooks.ts around line 15, the file
exports version '2.11.0' but the subpackage manifest files under
src/platform/react-hooks/res (package.cjs.json, package.mjs.json,
package.react.json) are missing or not updated with a "version": "2.11.0" field
and the top-level CHANGELOG.md lacks a new ## [2.11.0] – YYYY-MM-DD heading;
update each of the three manifest JSON files to include "version": "2.11.0" so
they match package.json and AblyReactHooks.ts, and insert a new release heading
`## [2.11.0] – YYYY-MM-DD` with your release notes above the existing `##
[2.10.1]` section in CHANGELOG.md.
ttypic
approved these changes
Aug 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#2060 had a public interface change, but as per 318fc5e commit message those fields were added prematurely and were not actually used so I decided not to include this change in the changelog as those fields were never mentioned before.
Summary by CodeRabbit
New Features
Chores