Skip to content

docs(cli): improve push publish and batch-publish reference docs#3356

Merged
sacOO7 merged 1 commit intofeature/ably-cli-reference-documentationfrom
docs/push-publish-reference-update
Apr 22, 2026
Merged

docs(cli): improve push publish and batch-publish reference docs#3356
sacOO7 merged 1 commit intofeature/ably-cli-reference-documentationfrom
docs/push-publish-reference-update

Conversation

@maratal
Copy link
Copy Markdown
Collaborator

@maratal maratal commented Apr 22, 2026

Summary

Improvements to ably push publish and ably push batch-publish reference documentation, on top of #3307.

  • push publish: Clarify --message flag — accepts plain text, JSON data, or full message object with name/data/extras fields. Add --message to all channel-based examples. Add inline notification.json file content example.
  • push batch-publish: Document both ./filename and @filename file path syntax. Document the optional "message" field in channel items including JSON object format. Add inline notifications.json file content example.

🤖 Generated with Claude Code

- Clarify --message flag: accepts plain text, JSON data, or full message object
- Add example showing full message object format for push publish
- Update batch-publish payload description with @filename syntax and message field
- Add batch-publish example showing "message" field in channel items

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: ad438cdd-5c1f-40a6-9f7a-67ecd8740ecd

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/push-publish-reference-update

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@maratal maratal requested a review from sacOO7 April 22, 2026 14:17
@maratal maratal marked this pull request as ready for review April 22, 2026 14:17
Copy link
Copy Markdown
Contributor

@sacOO7 sacOO7 left a comment

Choose a reason for hiding this comment

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

LGTM

@sacOO7 sacOO7 merged commit 60eb22b into feature/ably-cli-reference-documentation Apr 22, 2026
4 of 5 checks passed
@sacOO7 sacOO7 deleted the docs/push-publish-reference-update branch April 22, 2026 14:23
@sacOO7
Copy link
Copy Markdown
Contributor

sacOO7 commented Apr 22, 2026

Merged since #3353 wasn't able to merge due to some reason : (

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