release: prepare 0.10 release#62
Conversation
WalkthroughThis update increments the CLI version to 0.10.0 across documentation and configuration files. It renames the Changes
Sequence Diagram(s)sequenceDiagram
User->>CLI: ably rooms messages reactions send
CLI->>Ably API: Send reaction with parameters (including --count if specified)
Ably API-->>CLI: Acknowledge reaction sent
CLI-->>User: Output result
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ 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. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
CHANGELOG.md (1)
432-433: Bullet appears truncated.Line 432 ends abruptly after
ably channels occupancy– looks like half a sentence survived a merge. Please restore or remove to avoid confusion.README.md (1)
3549-3553: Stale example still refers to the removed “add” sub-commandThe example block still shows:
$ ably rooms messages reactions add my-room "message-id" "👍"This contradicts the new
sendsyntax and will confuse users.-$ ably rooms messages reactions add my-room "message-id" "👍" +$ ably rooms messages reactions send my-room "<MESSAGE_SERIAL>" "👍"
🧹 Nitpick comments (3)
CHANGELOG.md (1)
20-20: Minor nit – missing period.For consistency with the rest of the file, consider terminating the sentence with a period.
- - Race conditions in session storage to ensure smoother reconnection and consistent handling + - Race conditions in session storage to ensure smoother reconnection and consistent handling.README.md (2)
3624-3632: Add language spec to fenced code blockmarkdownlint MD040 is triggered because the code fence directly under “Remove a reaction …” lacks a language tag.
-``` +```sh
3672-3680: Same MD040 violation for the newsendexampleApply the same fix here:
-``` +```shThis keeps lint clean and enables syntax highlighting.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CHANGELOG.md(2 hunks)README.md(131 hunks)package.json(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
{README.md,docs/**,.cursor/rules/**}
📄 CodeRabbit Inference Engine (.cursor/rules/Development.mdc)
Update all relevant documentation, including README.md, files within the docs/ directory, and files within the .cursor/rules/ directory if the changes impact requirements, structure, testing procedures, development guidelines, Ably usage, or project structure.
Files:
README.md
🧠 Learnings (3)
package.json (14)
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Workflow.mdc:0-0
Timestamp: 2025-07-07T21:07:13.973Z
Learning: Execute pnpm prepare to ensure TypeScript compiles, oclif.manifest.json is updated, and README.md reflects command changes. Check for build errors in the output and ensure oclif.manifest.json and README.md changes (if any) are sensible.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Development.mdc:0-0
Timestamp: 2025-07-07T21:07:00.723Z
Learning: Run pnpm prepare to ensure the TypeScript code compiles successfully, the oclif.manifest.json is updated, and the README.md reflects any command changes before considering any task complete.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Development.mdc:0-0
Timestamp: 2025-07-07T21:07:00.723Z
Learning: Applies to package.json : Avoid unnecessary dependencies; keep dependencies to a pragmatic minimum.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Workflow.mdc:0-0
Timestamp: 2025-07-24T13:09:58.495Z
Learning: Before considering any task complete, you MUST run pnpm prepare to ensure TypeScript compiles, oclif.manifest.json is updated, and README.md reflects command changes. Verify build output for errors and sensible changes.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Development.mdc:0-0
Timestamp: 2025-07-24T13:09:42.990Z
Learning: If you want the oclif.manifest.json file to be updated and the README.md to be regenerated to reflect the command structure too, use pnpm prepare.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Development.mdc:0-0
Timestamp: 2025-07-07T21:07:00.723Z
Learning: If you want the oclif.manifest.json file to be updated and the README.md to be regenerated to reflect the command structure, use pnpm prepare.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Development.mdc:0-0
Timestamp: 2025-07-07T21:07:00.723Z
Learning: Applies to package.json : When installing libraries, do not pick a version manually in package.json; instead, use a script (e.g., pnpm add -D <package>) to install the latest version.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: The CLI is focused on Ably services - do not suggest features outside this scope.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-24T13:09:29.835Z
Learning: The CLI will always use the relevant product Ably SDKs for all data plane commands.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-07T21:06:41.172Z
Learning: The CLI must always use the relevant product Ably SDKs for all data plane commands.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-07T21:06:41.172Z
Learning: When the Ably API reference mentions SDK version 2.0, use https://ably.com/docs/sdk/js/v2.0/ for the most up-to-date information.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-24T13:09:29.835Z
Learning: When in doubt about how Ably works, refer to the Ably docs online at https://ably.com/docs to provide idiomatic suggestions in the CLI.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-07T21:06:41.172Z
Learning: When in doubt about how Ably works, refer to the Ably docs online at https://ably.com/docs to provide idiomatic suggestions in the CLI.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: Applies to src/commands/**/*.ts : Do not use direct HTTP requests (e.g., fetch) for data plane APIs; use the Ably SDK instead.
CHANGELOG.md (5)
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: Applies to src/commands/**/*.ts : Do not use hardcoded endpoint URLs; use configuration values (e.g., flags.controlHost, config.controlHost) when constructing URLs.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: The CLI is focused on Ably services - do not suggest features outside this scope.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-24T13:09:29.835Z
Learning: When in doubt about how Ably works, refer to the Ably docs online at https://ably.com/docs to provide idiomatic suggestions in the CLI.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-07T21:06:41.172Z
Learning: When in doubt about how Ably works, refer to the Ably docs online at https://ably.com/docs to provide idiomatic suggestions in the CLI.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: Applies to src/commands/**/*.ts : Do not use direct HTTP requests (e.g., fetch) for data plane APIs; use the Ably SDK instead.
README.md (14)
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Development.mdc:0-0
Timestamp: 2025-07-07T21:07:00.723Z
Learning: Applies to {README.md,docs/,.cursor/rules/} : Update all relevant documentation, including README.md, files within the docs/ directory, and files within the .cursor/rules/ directory if changes affect requirements, structure, testing procedures, development guidelines, Ably usage, or project structure.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Development.mdc:0-0
Timestamp: 2025-07-24T13:09:42.990Z
Learning: Applies to {README.md,docs/,.cursor/rules/} : Update all relevant documentation, including README.md, files within the docs/ directory, and files within the .cursor/rules/ directory if the changes impact requirements, structure, testing procedures, development guidelines, Ably usage, or project structure.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Workflow.mdc:0-0
Timestamp: 2025-07-07T21:07:13.973Z
Learning: Review and update all relevant documentation and rule files based on your changes, including README.md, docs/*.md, .cursor/rules/*.mdc, and docs/TODO.md.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-24T13:09:29.835Z
Learning: When in doubt about how Ably works, refer to the Ably docs online at https://ably.com/docs to provide idiomatic suggestions in the CLI.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-07T21:06:41.172Z
Learning: When in doubt about how Ably works, refer to the Ably docs online at https://ably.com/docs to provide idiomatic suggestions in the CLI.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-24T13:09:29.835Z
Learning: The CLI will always use the relevant product Ably SDKs for all data plane commands.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-07T21:06:41.172Z
Learning: The CLI must always use the relevant product Ably SDKs for all data plane commands.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: The CLI is focused on Ably services - do not suggest features outside this scope.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-07T21:06:41.172Z
Learning: When the Ably API reference mentions SDK version 2.0, use https://ably.com/docs/sdk/js/v2.0/ for the most up-to-date information.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: Applies to src/commands/**/*.ts : Do not use direct HTTP requests (e.g., fetch) for data plane APIs; use the Ably SDK instead.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-24T13:09:29.835Z
Learning: Pay attention to the following Ably documentation: Pub/Sub guides and API references, Chat guides and API references, Spaces guides and API references, Control API docs and references, and broader platform docs.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/Ably.mdc:0-0
Timestamp: 2025-07-07T21:06:41.172Z
Learning: Pay attention to the following Ably documentation: Pub/Sub guides and API references, Chat guides and API references, Spaces guides and API references, Control API docs and references, and broader platform docs.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: Applies to src/commands/**/*.ts : Command should support auth via the standard auth helper (import { getAuth } from '../../helpers/auth') and use it in the run method.
Learnt from: CR
PR: ably/cli#0
File: .cursor/rules/AI-Assistance.mdc:0-0
Timestamp: 2025-07-24T13:09:23.307Z
Learning: Applies to **/*.test.ts : When testing, mock the Ably SDK properly by stubbing the constructor (e.g., sinon.stub(Ably, 'Rest').returns(mockClient)).
🪛 markdownlint-cli2 (0.17.2)
README.md
3627-3627: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
3672-3672: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ 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). (3)
- GitHub Check: e2e-web-cli
- GitHub Check: e2e-cli
- GitHub Check: test
🔇 Additional comments (4)
package.json (1)
3-3: Version bump looks fine – please runpnpm prepareand commit the regenerated artefacts.Updating
"version"to0.10.0is expected for the release, but remember that the manifest and README are generated from the build.
Before merging, run:pnpm prepareand commit any resulting changes to
oclif.manifest.json/README.mdso the published package is consistent.CHANGELOG.md (1)
8-21: Changelog entry is clear – ensure docs & examples reflect the command rename.
rooms messages reactions add→sendis called out here; double-check the README, usage examples and any integration tests were updated to the new spelling so users don’t hit a mismatch.README.md (2)
30-32: Ensure version bump is propagated everywhereThe README now shows
@ably/cli/0.10.0, but other artefacts (e.g., package.json badge, installation snippets in docs/ and .cursor/rules/) should all reference the same version to avoid drift.
Please run a quick grep to confirm there are no lingering0.9.references.
180-184: Command rename propagated, but verify ancillary docs
rooms messages reactions sendcorrectly replaces the deprecated add variant in the command index.
Double-check that:
- The alias
addis actually removed from the CLI code (no hidden deprecated command).- All deep-link anchors inside docs/ still resolve (search for
#ably-rooms-messages-reactions-add).If remnants exist they’ll 404 from the TOC.
2 participants
Summary by CodeRabbit
Documentation
--countflag for sending multiple reactions.Chores