迁移到 Capgo
复制一个包含安装步骤和此插件的完整Markdown指南的设置提示
⚡️ Capgo 自动化频道、捆绑包清理、回滚、分析和 CLI 原生上传。使用本指南执行最小化的步骤以迁移并可选地重建任何您仍需要的自定义行为。
概述
概述标题- 收集您的现有 Capawesome 云配置(App ID、频道、签名密钥、 CLI 令牌)以便稍后存档或审计。
- 安装 Capgo 插件,移除 Capawesome SDK,并调用
CapacitorUpdater.notifyAppReady(). - 配置可选行为(手动下载、捆绑包固定、重新加载)如果您依赖这些流程今天
With Capgo,您只需安装我们的插件并调用 CapacitorUpdater.notifyAppReady()Everything else—channels, bundle cleanup, rollbacks, analytics, and CLI automation—is handled natively. The sections below walk through each task directly.
- 确保您的项目已经使用 Capacitor 5 或更高版本。
- 如果您计划从 CI/CD 推送包裹,请安装 Capgo CLI(
npm install -g @capgo/cli)。
步骤 1 — 安装 Capgo 并删除 Capawesome SDK
Section titled “步骤 1 — 安装 Capgo 并删除 Capawesome SDK”npm uninstall @capawesome/capacitor-live-updatenpm install @capgo/capacitor-updaternpx cap sync这是唯一的强制性交换。 Capgo 的本地 code 附带了插件;不需要额外的 JavaScript 助手。
第 2 步 – 最小配置
标题:第 2 步 – 最小配置之前的设置需要映射数十个选项 capacitor.configCapgo 能够自动识别您的项目,因此最小配置如下:
import { CapacitorConfig } from '@capacitor/cli'
const config: CapacitorConfig = { plugins: { CapacitorUpdater: { autoUpdate: true, autoDeletePrevious: true, periodCheckDelay: 10 * 60 * 1000, // optional: check every 10 minutes }, },}
export default configCapawesome 列出的所有手动标志(包括保留策略等)都可以通过 __CAPGO_KEEP_0__ 控制台或 __CAPGO_KEEP_1__ 来管理。您只需要覆盖这些键,如果您想与 __CAPGO_KEEP_2__ 的默认行为不同。defaultChannel, autoDeleteBundles, retention policies, etc.) is managed through the Capgo dashboard or API. You only need to override these keys if you want behaviour that differs from Capgo’s defaults.
标题:配置快速参考
Capawesome 选项| __CAPGO_KEEP_0__ 等效项 | Capgo equivalent | 您需要设置吗? |
|---|---|---|
appId | 从Capgo创建项目后,会从Capgo控制台获取 | 如果您在一个二进制文件中使用多个项目 |
defaultChannel | API控制台中管理的频道规则 | 可选;大多数团队在服务器端设置 |
autoDeleteBundles | autoDeletePrevious: true (默认) | 已启用 |
publicKey | 在Capgo控制台中管理 | 如果您手动轮换密钥 |
maxVersions /保留 | 包裹保留策略 | 在Capgo中集中配置(默认1个月,最大24个月) |
步骤 3 – 调用 notifyAppReady() (唯一必需的钩子)
标题:步骤 3 – 调用 notifyAppReady() (唯一必需的钩子)旧的工作流程引入了自定义监听器(checkForUpdates(), retryDownload(), hiding the splash screen, etc.). Capgo performs those steps natively. The only API you must call is:
import { CapacitorUpdater } from '@capgo/capacitor-updater'
CapacitorUpdater.notifyAppReady()这确认应用程序成功启动。如果确认信息永远不会到达,Capgo 将自动回滚捆绑包—无需额外的 JavaScript。
就这样了,Capgo 自动处理后台检查、启动屏幕可见性和回滚。
可选:在启动屏幕隐藏之前运行自定义逻辑
import { CapacitorUpdater } from '@capgo/capacitor-updater'import { SplashScreen } from '@capacitor/splash-screen'
CapacitorUpdater.addListener('appReady', () => { // Run diagnostics or logging if you need to SplashScreen.hide()})
CapacitorUpdater.notifyAppReady()步骤 4 – 映射 API 调用(大多数可选)
标题:步骤 4 – 映射 API 调用(大多数可选)In Capgo 中,您通常让自动更新器运行;手动 API 仍然可用,如果您需要完全控制。
| Capawesome 云 | Capgo 等价物 | 您需要它吗? |
|---|---|---|
LiveUpdate.fetchLatestBundle() | CapacitorUpdater.getLatest() | 只有在实现自己的下载工作流程时 |
LiveUpdate.downloadBundle() | CapacitorUpdater.download() | 可选:本地自动更新已经下载 |
LiveUpdate.setNextBundle() | CapacitorUpdater.next() | 可选:仪表板自动固定包 |
LiveUpdate.reload() | CapacitorUpdater.reload() | 可选;Capgo 强制必须的包后 notifyAppReady() |
LiveUpdate.getCurrentBundle() | CapacitorUpdater.current() | 可选诊断 |
如果您坚持使用本地自动更新行为,您可以删除 Capawesome JavaScript。
手动控制示例
标题:手动控制示例下载最新的包
import { CapacitorUpdater } from '@capgo/capacitor-updater'
const downloadUpdate = async () => { const latest = await CapacitorUpdater.getLatest() if (latest?.url) { const bundle = await CapacitorUpdater.download({ url: latest.url, version: latest.version, }) console.log('Bundle downloaded', bundle?.id) }}import { LiveUpdate } from '@capawesome/capacitor-live-update'
const downloadUpdate = async () => { const result = await LiveUpdate.fetchLatestBundle() if (result.downloadUrl) { await LiveUpdate.downloadBundle({ bundleId: result.bundleId, url: result.downloadUrl, }) console.log('Bundle downloaded') }}设置下一个包
import { CapacitorUpdater } from '@capgo/capacitor-updater'
const setNextBundle = async () => { await CapacitorUpdater.next({ id: 'bundle-id-123' })}import { LiveUpdate } from '@capawesome/capacitor-live-update'
const setNextBundle = async () => { await LiveUpdate.setNextBundle({ bundleId: 'bundle-id-123' })}立即应用下载的包
import { CapacitorUpdater } from '@capgo/capacitor-updater'
const applyUpdate = async () => { await CapacitorUpdater.reload()}import { LiveUpdate } from '@capawesome/capacitor-live-update'
const applyUpdate = async () => { await LiveUpdate.reload()}步骤 5 – 更新策略:Capgo如何处理它们
步骤 5 – 更新策略:Capgo如何处理它们Capawesome 文档了三种策略。以下是它们的翻译:
后台更新
后台更新- 之前的工作流程: 在code中配置并手动下载。
- Capgo__CAPGO_KEEP_0__
autoUpdate: true. 无需额外的code。
最新版本
标题:最新版本- 之前的工作流程: 添加一个
App.resume监听器,调用download, 然后set. - Capgocontext
: 后台自动更新已经在恢复后执行检查。您只需要手动监听器,如果您想自定义间隔。
import { App } from '@capacitor/app'import { CapacitorUpdater } from '@capgo/capacitor-updater'
App.addListener('resume', async () => { const latest = await CapacitorUpdater.getLatest() if (latest?.url) { const downloaded = await CapacitorUpdater.download({ url: latest.url, version: latest.version, }) if (downloaded) { await CapacitorUpdater.next({ id: downloaded.id }) } }})复制到剪贴板中(Copy to clipboard)
Section titled “强制更新”- 之前的工作流程: wire prompt logic and enforce reload.
- Capgo__CAPGO_KEEP_0__
majorAvailable: mark the bundle as “强制” in the dashboard, then listen for thenotifyAppReady()事件(在
) to require users to upgrade inside your app.
步骤6 – 部署包Section titled “步骤6 – 部署包” capawesome live-update deploy, Capgo offers a similar CLI workflow, and you can also automate deployments entirely via API.
# Authenticate once (stores a token in your CI environment)capgo login
# Upload a new bundle (auto-detects platform/version)capgo bundle upload --path dist --channel production因为 Capgo 自动跟踪捆绑包健康状况,所以您还获得:
- 每次安装都有设备级别的审计日志。
- 自动保留(默认为一个月)可配置的限制至24个月。
- 实时延迟指标在 status.capgo.app/history.
迁移时间线
标题:迁移时间线- 库存 & 安装: 10 分钟 (
npm install, 移除旧插件). - 配置 & 准备: 5 分钟 (
notifyAppReady). - Sanity checks: 15 分钟 (可选手动测试或监听器).
- 首次部署: 10 minutes with Capgo CLI or CI integration.
: 10 分钟 with __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ 或 CI 集成.
Capgo support
Capgo 支持- __CAPGO_KEEP_0__ 支持迁移顾问 book.capgo.app/demo.
- 预约.__CAPGO_KEEP_0__.app/demo - 社区 - 导航标签 - 社区资源 - Capgo 市场网站 - 网站底部 - 短 UI 标签或导航项 - 消息键 `community` (社区).: 加入 Capgo Discord.
- 问题跟踪: github.com/Cap-go/capacitor-updater/issues.
Capgo 是为长期可靠性而设计的:原生delta更新、加密的捆绑包、自动回滚和不需要自定义JavaScript的分析。 一旦您迁移,您就可以删除维护繁重的胶水,让平台自动运行更新。
Keep going from Migrate from Capawesome Cloud to Capgo
Section titled “Keep going from Migrate from Capawesome Cloud to Capgo”如果您正在使用 Migrate from Capawesome Cloud to Capgo 来规划CI/CD自动化,连接它到 Capgo CI/CD for the product workflow in Capgo CI/CD, Capgo 原生构建 为产品工作流程在 Capgo 原生构建中 Capgo 集成 为产品工作流程在 Capgo 集成中 CI/CD 集成 为 CI/CD 集成的实现细节 GitHub 动作集成 为 GitHub 动作集成的实现细节