Skip to content

fix: update channel push CLI commands to use push publish --channel flag#3310

Merged
maratal merged 3 commits intomainfrom
DX-927-new-CLI-push-commands-
May 7, 2026
Merged

fix: update channel push CLI commands to use push publish --channel flag#3310
maratal merged 3 commits intomainfrom
DX-927-new-CLI-push-commands-

Conversation

@maratal
Copy link
Copy Markdown
Collaborator

@maratal maratal commented Apr 5, 2026

Summary

  • Replace legacy ably channels publish with inline JSON extras in APNs, FCM, and web push getting-started guides
  • Use the new ably push publish --channel <name> flag with --title, --body, and --data options
  • Update surrounding text to match the new command style

https://ably.atlassian.net/browse/DX-927

@maratal maratal requested a review from sacOO7 April 5, 2026 23:28
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 5, 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: 880ebe8a-b35d-4538-ac50-8bce0cbe4f3a

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 DX-927-new-CLI-push-commands-

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.

@sacOO7
Copy link
Copy Markdown
Contributor

sacOO7 commented Apr 14, 2026

You might like to link push related commands to #3307

@maratal
Copy link
Copy Markdown
Collaborator Author

maratal commented Apr 24, 2026

You might like to link push related commands to #3307

Added link to Next Steps fyi @sacOO7

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.

We don't use --channel flag anymore, this was replaced by CHANNEL_NAME as per ably/ably-cli#361. You should check latest ably push docs at https://ably.com/docs/cli/push/publish

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Push Notifications getting-started guides to use the newer Ably CLI push publish workflow for sending channel-based pushes, replacing the legacy channels publish example that embedded push extras JSON.

Changes:

  • Replace the channel push example command with ably push publish --channel ... plus --title/--body and a JSON payload argument.
  • Update surrounding instructional text to reflect the new CLI command style.
  • Add a “next steps” link intended to point readers to push-related CLI options.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File Description
src/pages/docs/push/getting-started/web.mdx Updates the channel push CLI example and adds a link to supposed push CLI command reference.
src/pages/docs/push/getting-started/fcm.mdx Updates the channel push CLI example and adds a link to supposed push CLI command reference.
src/pages/docs/push/getting-started/apns.mdx Updates the channel push CLI example and adds a link to supposed push CLI command reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/pages/docs/push/getting-started/web.mdx
Comment thread src/pages/docs/push/getting-started/web.mdx
Comment thread src/pages/docs/push/getting-started/fcm.mdx
Comment thread src/pages/docs/push/getting-started/fcm.mdx
Comment thread src/pages/docs/push/getting-started/apns.mdx
Comment thread src/pages/docs/push/getting-started/apns.mdx
@maratal
Copy link
Copy Markdown
Collaborator Author

maratal commented May 5, 2026

We don't use --channel flag anymore, this was replaced by CHANNEL_NAME as per ably/ably-cli#361. You should check latest ably push docs at https://ably.com/docs/cli/push/publish

I think in the case of push publish this flag was introduced as a way to distinguish from --device-id and --client-id flags, since we decided to collapse a long channel publish command with extras.push field into this short version of push publish with --channel and --message flags.

@sacOO7
Copy link
Copy Markdown
Contributor

sacOO7 commented May 5, 2026

We don't use --channel flag anymore, this was replaced by CHANNEL_NAME as per ably/ably-cli#361. You should check latest ably push docs at https://ably.com/docs/cli/push/publish

I think in the case of push publish this flag was introduced as a way to distinguish from --device-id and --client-id flags, since we decided to collapse a long channel publish command with extras.push field into this short version of push publish with --channel and --message flags.

You are right, seems it's the same way in doc as well as source code. The change was only made to ably push channels and not ably push publish so we are good.

sacOO7

This comment was marked as outdated.

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.

It's better to give explicit link to ably cli page since new users will not be aware of it

Comment thread src/pages/docs/push/getting-started/apns.mdx Outdated
Comment thread src/pages/docs/push/getting-started/fcm.mdx Outdated
Comment thread src/pages/docs/push/getting-started/web.mdx Outdated
maratal and others added 2 commits May 7, 2026 00:14
Replace legacy `ably channels publish` with extras JSON with the new
`ably push publish --channel` flag in APNs, FCM, and web push guides.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… add push CLI link to next steps

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@maratal maratal force-pushed the DX-927-new-CLI-push-commands- branch from 164e355 to de34a55 Compare May 6, 2026 22:24
…etting-started guides.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@maratal maratal force-pushed the DX-927-new-CLI-push-commands- branch from de34a55 to 511cb72 Compare May 6, 2026 22:32
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
PS. Make sure we have consistent cross linking for Ably CLI across other pages.

@maratal maratal merged commit 0124328 into main May 7, 2026
7 checks passed
@maratal maratal deleted the DX-927-new-CLI-push-commands- branch May 7, 2026 12:47
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.

3 participants