版本目标
复制一个设置提示,包括安装步骤和此插件的完整Markdown指南。
本指南解释了如何自动将最新兼容包传递给用户,基于他们的本机应用程序版本 类似于Ionic AppFlow的方法。这种方式确保了简化的更新管理和更快的发布,同时防止了兼容性问题。
Capgo’s version targeting system allows you to:
- 向不兼容的应用版本防止破坏性更改 防止不兼容的应用版本接收破坏性更改
- __CAPGO_KEEP_0__ __CAPGO_KEEP_0__
- 管理多个应用版本 同时无需复杂逻辑
- 无缝推送更新 到特定用户群
为什么版本目标定位很重要(尤其是AppFlow用户)
标题:为什么版本目标定位很重要(尤其是AppFlow用户)如果您熟悉 Ionic AppFlow,您就知道确保用户只接收兼容更新是多么重要。 AppFlow自动将实时更新包匹配到本机应用程序版本,防止向较旧的本机code发送不兼容的JavaScript。
Capgo提供相同的安全保证,并且具有额外的功能:
- 版本匹配的更细致的控制
- 多种策略(渠道、semver、原生约束)
- 版本分布的更好可视化
- API 和 CLI 控制与仪表盘管理一起使用
这种方法尤其适用于以下情况:
- 您有不同主版本的用户(例如v1.x、v2.x、v3.x)
- 您需要在推出破坏性更改时维护向后兼容性
- 您想防止新版本的包破坏旧的原生code
- 您正在逐渐从一个版本迁移到另一个版本
- 您正在从 AppFlow 迁移 并且想要维持相同的更新安全性
Capgo 使用多层次的方法来匹配用户与兼容的更新:
- 原生版本约束:防止不兼容的原生版本接收更新
- 渠道路由:将不同应用版本路由到不同的更新渠道
- 语义化版本控制:自动阻止跨主版本/次版本/修订版本的更新
- 设备级别覆盖:针对特定设备或用户组
版本匹配流程
标题:版本匹配流程graph TD A[User Opens App] --> B{Check Device Override} B -->|Override Set| C[Use Override Channel] B -->|No Override| D{Check local plugin channel} D -->|setChannel value| E[Use local setChannel channel] D -->|No local channel| F{Check defaultChannel in App} F -->|Has defaultChannel| G[Use App's defaultChannel] F -->|No defaultChannel| H[Use Cloud Default Channel] C --> I{Check Version Constraints} E --> I G --> I H --> I I -->|Compatible| J[Deliver Update] I -->|Incompatible| K[Skip Update]策略 1:基于频道的版本路由
标题:策略 1:基于频道的版本路由这是 推荐方法 用于管理重大变化和主要版本更新。它与 AppFlow 的交付模型类似。
示例场景
应用 v1.x- (100,000 名用户) → 频道
production应用 v2.x - (50,000 名用户具有破坏性更改) → 基于频道的版本路由是管理重大变化和主要版本更新的推荐方法。它类似于 AppFlow 的交付模型。
v2频道 - App v3.x (10,000 beta users) →
v3频道
实施
实施步骤 1:为每个主要版本配置频道
步骤 1:为每个主要版本配置频道// capacitor.config.ts for version 1.x buildsimport { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = { appId: 'com.example.app', appName: 'Example App', plugins: { CapacitorUpdater: { autoUpdate: 'atBackground', defaultChannel: 'production', // or omit for default } }};
export default config;// capacitor.config.ts for version 2.x buildsconst config: CapacitorConfig = { appId: 'com.example.app', appName: 'Example App', plugins: { CapacitorUpdater: { autoUpdate: 'atBackground', defaultChannel: 'v2', // Routes v2 users automatically } }};// capacitor.config.ts for version 3.x buildsconst config: CapacitorConfig = { appId: 'com.example.app', appName: 'Example App', plugins: { CapacitorUpdater: { autoUpdate: 'atBackground', defaultChannel: 'v3', // Routes v3 users automatically } }};步骤 2:创建频道
步骤 2:创建频道# Create channels for each major versionnpx @capgo/cli channel create productionnpx @capgo/cli channel create v2npx @capgo/cli channel create v3
# Enable self-assignment so apps can switch channelsnpx @capgo/cli channel set production --self-assignnpx @capgo/cli channel set v2 --self-assignnpx @capgo/cli channel set v3 --self-assign步骤 3:上传版本特定包
步骤 3:上传版本特定包# For v1.x users (from v1-maintenance branch)git checkout v1-maintenancenpm run buildnpx @capgo/cli bundle upload --channel production
# For v2.x users (from v2-maintenance or main branch)git checkout mainnpm run buildnpx @capgo/cli bundle upload --channel v2
# For v3.x users (from beta/v3 branch)git checkout betanpm run buildnpx @capgo/cli bundle upload --channel v3- 零 code 变化 - 自动发生频道路由
- 清晰的分离 - 每个版本都有自己的更新管道
- 灵活的目标 - 将更新推送到特定版本组
- 安全的滚动 - 不兼容版本的破坏性更改永远不会到达
使用 Capgo 内置 语义版本控制 防止跨版本边界更新。
防止重大版本之间的自动更新
防止重大版本之间的自动更新# Create a channel that blocks major version updatesnpx @capgo/cli channel create stable --disable-auto-update major这意味着:
- 应用程序版本的用户 1.2.3 将接收更新到 1.9.9
- 用户将 不会 接收版本 2.0.0 自动
- 防止破坏性变化到达较旧的本机code
- 比较使用发送的本机基线
version_build
细粒度控制选项
标题:细粒度控制选项# Block target bundles outside the native major.minor line (1.2.x won't get 1.3.0)npx @capgo/cli channel set stable --disable-auto-update minor
# Block target bundles outside the exact native MAJOR.MINOR.PATCH core (1.2.3 won't get 1.2.4)npx @capgo/cli channel set stable --disable-auto-update patch
# Allow all updatesnpx @capgo/cli channel set stable --disable-auto-update none策略 3:本机版本约束
本机版本约束策略为捆绑包指定最低本机版本要求,以防止向不兼容设备传递。
使用本机版本延迟条件
本机版本延迟条件当上传捆绑包时,您可以指定最低本机版本:
# This bundle requires native version 2.0.0 or highernpx @capgo/cli bundle upload \ --channel production \ --native-version "2.0.0"应用场景
应用场景标题-
新原生插件需要
终端窗口 # Bundle needs Camera plugin added in v2.0.0npx @capgo/cli bundle upload --native-version "2.0.0" -
原生API重大变更
终端窗口 # Bundle uses new Capacitor 6 APIsnpx @capgo/cli bundle upload --native-version "3.0.0" -
渐进式迁移
终端窗口 # Test bundle only on latest native versionnpx @capgo/cli bundle upload \--channel beta \--native-version "2.5.0"
预防自动降级策略4
策略 4:自动降级防护防止用户接收比他们当前本机版本更旧的捆绑包。
在频道设置中启用
频道设置在Capgo控制台中:
- 前往 频道 选择您的频道
- 启用 在本机下禁用自动降级
- 保存更改
或通过CLI:
npx @capgo/cli channel set production --disable-downgrade- 用户设备:原生版本 1.2.5
- 频道包:版本 1.2.3
- 结果: 更新被阻止(将会是降级)
这在以下情况下很有用:
- 用户手动从应用商店安装了更新的版本
- 您需要确保用户始终有最新的安全补丁
- 您想防止回归错误
策略 5:设备级别目标
标题:策略 5:设备级别目标为特定设备或用户组覆盖渠道分配
强制特定版本进行测试
标题:强制特定版本进行测试import { CapacitorUpdater } from '@capgo/capacitor-updater'
// Force beta testers to use v3 channelasync function assignBetaTesters() { const deviceId = await CapacitorUpdater.getDeviceId()
// Check if user is beta tester if (isBetaTester(userId)) { await CapacitorUpdater.setChannel({ channel: 'v3' }) }}设备管理
标题:设备管理在Capgo控制台中:
- 前往 设备 → 查找设备
- 点击 设置渠道 或 点击
- 设置版本
- 或使用特定的渠道或捆绑包版本
使用设备覆盖来在自己的设备上测试更新,之后再推广到所有用户。
完整的AppFlow样式工作流完整的AppFlow样式工作流
1. 初始设置 (App v1.0.0)
标题:1. 初始设置 (App v1.0.0)# Create production channel with semver controlsnpx @capgo/cli channel create production \ --disable-auto-update major \ --disable-downgradeconst config: CapacitorConfig = { plugins: { CapacitorUpdater: { autoUpdate: 'atBackground', defaultChannel: 'production', } }};2. 发布破坏性更改 (App v2.0.0)
标题:2. 发布破坏性更改 (App v2.0.0)# Create v2 channel for new versionnpx @capgo/cli channel create v2 \ --disable-auto-update major \ --disable-downgrade \ --self-assign
# Create git branch for v1 maintenancegit checkout -b v1-maintenancegit push origin v1-maintenance// capacitor.config.ts for v2.0.0const config: CapacitorConfig = { plugins: { CapacitorUpdater: { autoUpdate: 'atBackground', defaultChannel: 'v2', // New users get v2 channel } }};3. 推送更新到两种版本
Section titled “3. 将更新推送到两种版本”# Update v1.x users (bug fix)git checkout v1-maintenance# Make changesnpx @capgo/cli bundle upload \ --channel production \ --native-version "1.0.0"
# Update v2.x users (new feature)git checkout main# Make changesnpx @capgo/cli bundle upload \ --channel v2 \ --native-version "2.0.0"4. 监控版本分布
Section titled “4. 监控版本分布”使用Capgo控制台来跟踪:
- v1 和 v2 用户数量
- 每个版本的包装采用率
- 每个版本的错误或崩溃率
5. 废弃旧版本
Section titled “5. 废弃旧版本”一旦v1使用率低于阈值:
# Stop uploading to production channel# Optional: Delete v1 maintenance branchgit branch -d v1-maintenance
# Move all remaining users to default# (They'll need to update via app store)渠道顺序
渠道顺序当存在多个渠道配置时,Capgo遵循以下顺序:
- 设备覆盖 (控制台或API) - 优先级最高,且在设备覆盖 UI 中可见
- 本地插件渠道 通过
setChannel()- 只存储在设备上,不在设备覆盖 UI 中显示 - defaultChannel 在capacitor.config.ts中
- 默认频道 (Cloud设置) - 优先级最低
最佳实践
标题为“最佳实践”的部分1. 总是设置 major 版本的 defaultChannel
Section titled “1. 总是设置 major 版本的 defaultChannel”// ✅ Good: Each major version has explicit channel// v1.x → production// v2.x → v2// v3.x → v3
// ❌ Bad: Relying on dynamic channel switching// All versions → production, switch manually2. 使用语义版本
Section titled “2. 使用语义版本”# ✅ Good1.0.0 → 1.0.1 → 1.1.0 → 2.0.0
# ❌ Bad1.0 → 1.1 → 2 → 2.53. 保持单独的 branch
Section titled “3. 保持单独的 branch”# ✅ Good: Separate branches per major versionmain (v3.x)v2-maintenance (v2.x)v1-maintenance (v1.x)
# ❌ Bad: Single branch for all versions4. 在发布前进行测试
Section titled “4. 在发布前进行测试”# Test on beta channel firstnpx @capgo/cli bundle upload --channel beta
# Monitor for issues, then promote to productionnpx @capgo/cli bundle upload --channel production5. 监控版本分布
Section titled “5. 监控版本分布”定期检查您的仪表板:
- 用户是否正在升级到新版本的原生版本?
- 老版本是否仍然获得高流量?
- 是否应该弃用旧频道?
与Ionic AppFlow的比较
Section titled “与Ionic AppFlow的比较”对于从 Ionic AppFlow在这里是如何比较Capgo的版本目标的:
| 功能 | Ionic AppFlow | Capgo |
|---|---|---|
| 基于版本的路由 | 基于原生版本 | 基于 defaultChannel + 多种策略 |
| 语义版本 | 基本支持 | 高级 --disable-auto-update (主/次/修) |
| 原生版本约束 | 在 AppFlow 控制台中进行手动配置 | 内置 --native-version CLI 中的标志 |
| 频道管理 | Web UI + CLI | Web UI + CLI + API |
| 设备覆盖 | 设备级别的有限控制 | 通过控制台/API 进行全控制 |
| 防止自动降级 | 是 | 通过 --disable-downgrade |
| 多版本维护 | 手动分支/频道管理 | 自动(频道优先) |
| 自主托管 | 否 | 是(完全控制) |
| 版本分析 | 基本 | 详细每个版本指标 |
故障排除
用户未接收更新用户未接收更新
-
请检查以下内容:频道分配
const channel = await CapacitorUpdater.getChannel()console.log('Current channel:', channel) -
版本约束: 检查包是否有本机版本要求
- 仪表盘 → 包 → 检查“本机版本”列
-
Semver 设置: 验证渠道的
disable-auto-update设置终端窗口 npx @capgo/cli channel list -
设备覆盖: 检查设备是否有手动覆盖
- 仪表盘 → 设备 → 搜索设备 → 检查渠道/版本
包传递到错误版本
Section titled “错误的版本包”- Review defaultChannel: 确保正确的频道在
capacitor.config.ts - Check Bundle Upload: 验证包是否上传到正确的频道
- Inspect Native Version: 确认
--native-versionflag 是否被正确使用
Breaking Changes Affecting Old Versions
Section titled “影响旧版本的重大变更”- Immediate Fix: 强制更新受影响设备到安全包
- 仪表盘 → 设备 → 批量选择 → 设置版本
- 长期修复: 创建带有版本号的频道并维护独立分支
- 预防: 在发布之前始终在代表性设备上测试更新
从Ionic AppFlow迁移
标题:从Ionic AppFlow迁移如果您正在从Ionic AppFlow迁移 Ionic AppFlow,版本目标功能在Capgo中与Ionic AppFlow非常相似,但具有更好的灵活性:
概念映射
标题:概念映射| AppFlow Concept | Capgo Equivalent | Notes |
|---|---|---|
| 发布渠道 | Capgo 渠道 | 同样的概念,更加强大 |
| 原生版本锁定 | --native-version 标志 | 更细致的控制 |
| 渠道优先级 | 渠道优先级(覆盖 → 云 → 默认) | 更透明的优先级 |
| 发布目标 | 频道 + semver 控制 | 可用多种策略 |
| 生产频道 | production 频道 (或任意名称) | 灵活的命名 |
| 基于 Git 的部署 | CLI 分支上的包上传 | 相同的工作流程 |
| 自动版本匹配 | defaultChannel + 版本约束 | 增强了多种策略 |
AppFlow 用户的关键区别
标题:AppFlow 用户的关键区别- 更多控制: Capgo 提供了多种策略(渠道、语义版本号、原生版本)可以组合
- 更好的可见性: 控制台显示版本分布和兼容性问题
- API 访问: 对版本目标的完全程序化控制
- 自主托管: 可以使用相同的版本逻辑运行自己的更新服务器
迁移步骤
标题:迁移步骤- 将您的 AppFlow 通道映射到 __CAPGO_KEEP_0__ 通道(通常 1:1) to Capgo channels (usually 1:1)
- 在
defaultChannel每个主要版本capacitor.config.ts配置 semver 规则 - 如果您想在版本边界处自动阻止 上传版本特定的捆绑包
- 使用 标志
--native-version监控版本分布 - 在 __CAPGO_KEEP_0__ 控制台中 Capgo
高级模式
标题为“高级模式”按版本逐步发布
标题为“按版本逐步发布”// Gradually migrate v1 users to v2async function migrateUsers() { const deviceId = await CapacitorUpdater.getDeviceId() const rolloutPercentage = 10 // Start with 10%
// Hash device ID to get deterministic percentage const hash = hashCode(deviceId) % 100
if (hash < rolloutPercentage) { // User is in rollout group - migrate to v2 await CapacitorUpdater.setChannel({ channel: 'v2' }) }}按版本的功能标志
标题为“按版本的功能标志”// Enable features based on native versionasync function checkFeatureAvailability() { const info = await CapacitorUpdater.getDeviceId() const nativeVersion = info.nativeVersion
if (compareVersions(nativeVersion, '2.0.0') >= 0) { // Enable features requiring v2.0.0+ enableNewCameraFeature() }}版本间A/B测试
版本间A/B测试// Run A/B tests within same native versionasync function assignABTest() { const nativeVersion = await getNativeVersion()
if (nativeVersion.startsWith('2.')) { // Only A/B test on v2 users const variant = Math.random() < 0.5 ? 'v2-test-a' : 'v2-test-b' await CapacitorUpdater.setChannel({ channel: variant }) }}概要
概要Capgo 提供多种版本特定更新分发策略:
- 基于渠道的路由: 通过语义版本号自动分离版本
defaultChannel - 语义版本号: 防止更新跨越主版本/次版本/修订版本
- 原生版本约束: 为捆绑包要求最低的原生版本
- 防止自动降级: 不向新版原生版本发送旧版包
- 设备覆盖: 用于测试和目标的手动控制
通过结合这些策略,您可以实现AppFlow样式的自动更新交付,具有更大的灵活性和控制。 选择最适合您的应用版本和部署工作流程的方法。
有关特定功能的更多详细信息,请参阅:
继续从版本目标定向
继续从版本目标定向如果您正在使用 版本目标定向 连接它与 渠道 渠道 渠道 渠道 Beta 测试解决方案 beta 测试解决方案 beta 测试解决方案 为 Beta 测试解决方案中的产品工作流程, 和 版本目标解决方案 为版本目标解决方案中的产品工作流程, 和