Skip to content

docs(capacitor): update Capawesome Cloud live update section - #18568

Open
djabif wants to merge 1 commit into
quasarframework:devfrom
djabif:docs/capawesome-live-updates
Open

djabif wants to merge 1 commit into
quasarframework:devfrom
djabif:docs/capawesome-live-updates

Conversation

@djabif

@djabif djabif commented Oct 8, 2026 •

Copy link
Copy Markdown

What changes and why

Brings the Capawesome Cloud section of the Capacitor live-updates page in line with the current Capawesome docs:

  • The apps:bundles:create CLI command no longer exists; the current command is apps:liveupdates:upload. Users following the page today get an error at the publish step.
  • The CLI invocation now matches the documented form (npx @capawesome/cli ...) instead of a global install.
  • The plugin configuration now includes the recommended settings (autoUpdateStrategy, readyTimeout, autoBlockRolledBackBundles) so that automatic rollback works, which the page's own caution box asks readers to test. The usage example now calls ready() and uses the nextBundleSet event instead of forcing a reload on every start.
  • Adds the Capacitor 6/7 LTS install note, the iOS privacy manifest pointer, test steps, a note not to test under live reload, and a warning about keeping bundles compatible with the installed native binary.
  • Updates links that were redirecting to their current URLs.
  • Adds short subsections on signing bundles (which the page's caution box asks for) and on channels, gradual rollouts and publishing from CI.

Breaking change?

No. Docs only.

How was it validated?

Commands and options checked against the current @capawesome/cli and @capawesome/capacitor-live-update references; all links return 200.

Summary by CodeRabbit

  • Documentation
    • Clarified the differences between the open-source live-update plugin and Capawesome Cloud.
    • Expanded guidance on installation, update readiness, rollback behavior, and reloading while preserving in-memory state.
    • Updated bundle publishing instructions, including release-build testing, native-version compatibility, code signing, rollout channels, and CI authentication.

@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: quasarframework/quasar/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 376f84d0-d339-4842-82c6-e2c71088812b
📥 Commits

Reviewing files that changed from the base of the PR and between e282e82 and b40afc2.

📒 Files selected for processing (1)
  • docs/src/pages/quasar-cli-vite/developing-capacitor-apps/live-updates.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The guide now distinguishes the open-source Live Update plugin from Capawesome Cloud. It documents plugin setup, update readiness and reload handling, and bundle publishing options.

Changes

Capacitor Live Updates Guide

Layer / File(s) Summary
Plugin setup and update configuration
docs/src/pages/quasar-cli-vite/developing-capacitor-apps/live-updates.md
The guide distinguishes the open-source plugin from Cloud, adds Capacitor version guidance and an iOS privacy-manifest note, and describes background updates and rollback settings.
Update readiness and reload handling
docs/src/pages/quasar-cli-vite/developing-capacitor-apps/live-updates.md
The example calls ready() early and listens for nextBundleSet before asking whether to reload. The guide notes that reload discards in-memory state.
Bundle publishing and release options
docs/src/pages/quasar-cli-vite/developing-capacitor-apps/live-updates.md
The guide documents CLI login and uploads, release-build compatibility, bundle signing, channels, rollout percentages, and CI publishing.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: rstoenescu

Merge Risk: ⚪ Minimal · up to b40af

The reviewed update guide has no established defect that should block merging.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required Conventional Commit format with the valid type "docs", the affected area "capacitor", and a subject that accurately describes the documentation changes.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Undocumented Breaking Change ✅ Passed PASS — the pull request changes only one Markdown documentation file. It does not change component APIs, plugin implementation, CLI behavior, or configuration handling. The new `apps:liveupdates:uploa…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant