Skip to content

docs: add channel-based OTA deployment tutorial with CI/CD automationAdd files via upload#23

Open
tungpham-dev wants to merge 2 commits into
Cap-go:mainfrom
tungpham-dev:channel-deployment-tutorial
Open

docs: add channel-based OTA deployment tutorial with CI/CD automationAdd files via upload#23
tungpham-dev wants to merge 2 commits into
Cap-go:mainfrom
tungpham-dev:channel-deployment-tutorial

Conversation

@tungpham-dev
Copy link
Copy Markdown

@tungpham-dev tungpham-dev commented May 24, 2026

Adds a new tutorial covering channel-based OTA deployment strategy with Capgo.

This is one of the most powerful Capgo features but currently has no
dedicated step-by-step guide. The tutorial covers:

  • Setting up development, beta, and production channels
  • Uploading bundles to specific channels via CLI
  • Device assignment (both self-assignment and server-side forced assignment)
  • Checking and displaying the active channel in-app
  • Full GitHub Actions CI/CD workflow that auto-deploys to the correct
    channel based on the git branch
  • Monitoring rollout success rates and disabling bad bundles
  • Best practices for safe OTA deployment

Target audience: Capgo users who have basic OTA updates working and
want to implement a safer, staged rollout strategy.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide for channel-based over-the-air deployments: plugin installation and initialization, configuring deployment settings, creating development/beta/production channels, uploading and promoting bundles, client and server device channel assignment, reading the active channel, automating uploads via CI based on branch, monitoring deployments and rolling back, plus best practices and a summary pipeline.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 24, 2026

📝 Walkthrough

Walkthrough

Adds a comprehensive tutorial documenting channel-based OTA deployment with the Capgo Capacitor updater: setup and init, capacitor config, creating channels, uploading/promoting bundles, client/server device assignment, GitHub Actions automation, monitoring, rollback, and best practices.

Changes

Channel-Based OTA Deployment Guide

Layer / File(s) Summary
Channel-Based OTA Deployment Guide
capgo-channel-deployment.md
Complete tutorial teaching setup (plugin installation and initialization), capacitor config, channel creation (development, beta, production), bundle uploads and promotion, client-side and server-side device assignment, reading active channel, GitHub Actions automation based on branch name, dashboard monitoring, rollback via bundle disable, and best practices.

🎯 2 (Simple) | ⏱️ ~15 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title primarily describes adding a channel-based OTA deployment tutorial with CI/CD automation, which matches the main content of the PR (new documentation page). However, it includes redundant text 'Add files via upload' that appears to be accidentally appended.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@capgo-channel-deployment.md`:
- Around line 24-29: Add the Capgo CLI authentication step to the Prerequisites:
update the prerequisites section to instruct first-time users to authenticate
the CLI by running the Capgo login command (use the official command string npx
`@capgo/cli`@latest login and mention supplying their API key) so subsequent
commands like npx `@capgo/cli` ... channel add and bundle upload/set/disable will
work; place this line directly after the Capgo account bullet and make it
explicit that the CLI stores the API key for future commands.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: ac273385-232f-40c1-b3b9-0c3730c14236

📥 Commits

Reviewing files that changed from the base of the PR and between 49f3fa4 and f6b1f81.

📒 Files selected for processing (1)
  • capgo-channel-deployment.md

Comment thread capgo-channel-deployment.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

♻️ Duplicate comments (1)
capgo-channel-deployment.md (1)

30-31: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Add the exact CLI auth command in prerequisites.

Line 30-Line 31 introduces the requirement but still omits the actual command, so first-time users can’t execute subsequent channel/bundle commands reliably. Please include the explicit login command and note key persistence.

Suggested doc patch
 Authenticate the Capgo CLI once before running channel/bundle commands:
+
+```bash
+npx `@capgo/cli`@latest login <YOUR_API_KEY>
+```
+
+This stores your API key for future CLI commands.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@capgo-channel-deployment.md` around lines 30 - 31, Update the prerequisites
section introduced by "Authenticate the Capgo CLI once before running
channel/bundle commands" to include the exact CLI auth command to run (npx
`@capgo/cli`@latest login <YOUR_API_KEY>) and add a brief note that this stores
the API key locally for subsequent CLI commands so first-time users can run
channel/bundle commands reliably.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Duplicate comments:
In `@capgo-channel-deployment.md`:
- Around line 30-31: Update the prerequisites section introduced by
"Authenticate the Capgo CLI once before running channel/bundle commands" to
include the exact CLI auth command to run (npx `@capgo/cli`@latest login
<YOUR_API_KEY>) and add a brief note that this stores the API key locally for
subsequent CLI commands so first-time users can run channel/bundle commands
reliably.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 20c6c712-086a-45c9-b8cd-6c16f3071993

📥 Commits

Reviewing files that changed from the base of the PR and between f6b1f81 and 8c17615.

📒 Files selected for processing (1)
  • capgo-channel-deployment.md

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