每个移动开发团队都曾经感受到的痛苦:一个功能已经准备好进行审查,但将其传递给利益相关者的手段意味着要穿越TestFlight或Google Play beta评审迷宫。应该花费几分钟的时间却变成了等待、安装和管理beta版本的几个小时。
如果您的生产应用程序可以直接从任何pull请求中拉取最新的更改并将其直接应用到设备上,而无需重新安装或应用商店延迟呢?
这就是 PR预览 使其成为可能。当开发人员打开一个pull请求时,一个GitHub动作创建了一个专门的更新频道并发布了更改。安装了该应用程序的任何人都可以切换到该频道,测试该功能,然后切换回原来的应用程序——所有这一切都在不离开他们已经拥有的应用程序的情况下完成。
TestFlight问题
传统的测试移动功能的工作流程大致如下:
- 开发人员打开PR - Code已准备就绪
- 等待TestFlight - 15-30分钟的处理时间
- 找到并安装 - 测试人员寻找合适的构建
- - 测试和重复 - 每次变更意味着另一次等待
这会造成瓶颈。 QA 等待构建而被阻塞。 产品经理无法快速验证功能。 开发人员在等待反馈时会失去上下文。 行业估计这会导致每个 PR 的生产力损失约为 340 美元。
如何 PR 预览工作
PR 预览使用 Capgo 的频道系统来创建每个 PR 的更新流。 这是流程:
- PR 打开或更新 - GitHub 动作触发
- 上传包 - 您的 JS/CSS 变更将发送到一个 PR 特有的频道
- 评论发布 - 测试人员在 PR 中接收指示
- 即刻测试 - 切换频道,测试,切换回
无需新应用安装,无需TestFlight延迟。同一生产应用可以从不同更新频道拉取。
设置PR预览
在您可以实现PR预览之前,项目需要配置Capgo Live Updates。请遵循 Capgo 快速入门指南 如果您尚未完成。
GitHub Actions 工作流
创建 .github/workflows/pr-preview.yml:
name: PR Preview
on:
pull_request:
types: [opened, synchronize]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Setup Bun
uses: oven-sh/setup-bun@v2
- name: Install Dependencies
run: bun install
- name: Build
run: bun run build
# Create a channel named after your PR (may already exist on synchronize)
- name: Create PR Channel
id: create_channel
continue-on-error: true
run: bunx @capgo/cli@latest channel add pr-${{ github.event.pull_request.number }} --self-assign
env:
CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
# Upload the build to that channel
- name: Upload to Capgo
run: bunx @capgo/cli@latest bundle upload --channel pr-${{ github.event.pull_request.number }}
env:
CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
# Post a comment with testing instructions (only on PR open)
- name: Comment on PR
if: github.event.action == 'opened'
uses: actions/github-script@v7
with:
script: |
github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: ${{ github.event.pull_request.number }},
body: '📱 **Test this PR on device:**\n\nOpen your app and switch to channel: `pr-${{ github.event.pull_request.number }}`\n\nUse the shake menu or call `setChannel()` from your app.'
})
关键是 --self-assign 标志在创建频道时。这样测试者就可以在应用内部使用__CAPGO_KEEP_0__切换到频道。 setChannel() API
设置Capgo令牌
- 前往您的 Capgo控制台
- 导航至设置 > API密钥
- 生成一个新的密钥
all权限 - 将其添加为
CAPGO_TOKEN在您的GitHub仓库密钥中
测试人员如何切换频道
测试人员有两种方式切换到PR频道:
选项1:摇动菜单(最简单)
在您的Capacitor配置中启用摇动菜单和频道选择器
// capacitor.config.ts
const config: CapacitorConfig = {
// ... your other config
plugins: {
CapacitorUpdater: {
shakeMenu: true,
allowShakeChannelSelector: true
}
}
};
测试人员摇晃他们的设备以打开调试菜单,菜单中显示可用的频道列表并带有搜索栏。他们找到他们的PR频道(例如,)、点击选择它,应用程序自动下载并应用更新。当测试完成时,他们再次摇晃并切换回生产环境。 pr-123测试人员通过摇晃设备来打开调试菜单,菜单中显示可用的频道列表并带有搜索栏。他们找到他们的PR频道(例如,)、点击选择它,应用程序自动下载并应用更新。当测试完成时,他们再次摇晃并切换回生产环境。
摇晃菜单会自动处理整个流程:
- 通过获取所有可自行赋予的频道来获取所有自赋予频道
listChannels() - 显示频道列表并带有搜索栏以便找到特定的PR
- 下载选定的更新
- 提示重新加载并提供“立即重新加载”/“稍后”选项
选项2:自定义频道选择器UI
在应用程序中构建一个频道切换器,列出可用的PR频道并让测试人员选择一个。这使用了两个关键API:
listChannels()- 获取所有启用自赋予的频道setChannel()- 将设备切换到选定的频道
import { CapacitorUpdater } from '@capgo/capacitor-updater';
// Get all available channels (including PR channels)
async function getAvailableChannels() {
const { channels } = await CapacitorUpdater.listChannels();
// Filter to show only PR channels
const prChannels = channels.filter(c => c.name.startsWith('pr-'));
return prChannels;
}
// Switch to a specific PR channel
async function switchToChannel(channelName: string) {
await CapacitorUpdater.setChannel({
channel: channelName,
triggerAutoUpdate: true // Immediately check for updates
});
}
// Return to production
async function switchBackToProduction() {
await CapacitorUpdater.unsetChannel({});
}
// Get current channel
async function getCurrentChannel() {
const { channel } = await CapacitorUpdater.getChannel();
return channel;
}
使用这些构建块,您可以创建一个简单的UI:
// Example: List PR channels and let user select
const channels = await getAvailableChannels();
const current = await getCurrentChannel();
// Display channels in your UI
channels.forEach(channel => {
console.log(`${channel.name} ${channel.name === current ? '(current)' : ''}`);
});
// When user selects a channel
await switchToChannel('pr-123');
对于一个完整的React组件示例,请参见 我们的频道浏览文章.
清理PR频道
当PR被合并或关闭时,您将希望清理频道。添加另一个工作流程:
name: Cleanup PR Preview
on:
pull_request:
types: [closed]
jobs:
cleanup:
runs-on: ubuntu-latest
steps:
- name: Delete PR Channel
run: bunx @capgo/cli@latest channel delete pr-${{ github.event.pull_request.number }}
env:
CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}
这会在PR关闭时删除频道,使您的频道列表保持干净。
版本兼容性
PR预览仅在JavaScript包与安装的原生版本兼容时才有效。如果您的PR包含原生code更改(新Capacitor插件,iOS/Android修改),测试人员将需要一个新的原生构建。
Capgo会自动检查版本兼容性。如果一个PR的包目标的是不同的原生版本,而不是安装的版本,更新将不会被应用。这会防止由于不兼容code而导致的崩溃。
对于需要原生更改的PR,您将需要分发一个新的TestFlight/Play Store构建。PR预览对于JavaScript、CSS和资产更改最有效,这些更改不涉及原生code。
谁从PR预览中受益
测试工程师
- 上下文:Capgo解决方案营销页面。角色:短的UI标签或导航项。见于:页面解决方案/pr-preview.astro。消息键`解决方案_pr_preview_teams_qa` (Solutions Pr Preview Teams Qa)。
- 切换多个 PR 无需重新安装
- 在真实设备上验证修复和回归
- 不再等待 TestFlight 处理
产品经理
- 在合并前预览功能
- 直接在 PR 上给出反馈
- 验证实现是否符合要求
- 减少审查周期
开发者
- 更快速地获取对变化的反馈
- 即时演示功能给利益相关者
- 使用特定用户调试问题
- 节省更多时间管理测试版
比较:传统版 vs PR 预览
| 方面 | 测试飞行/测试版 | Capgo PR 预览 |
|---|---|---|
| 构建时间 | 15-30 分钟 | 小于 1 分钟 |
| 切换 PR | 5+ 分钟重新安装 | 10 秒 |
| 设置复杂度 | App Store凭据 | 一个工作流文件 |
| 清理 | 手动 | 自动 |
| 原生code更改 | 必需 | (JS仅)可选 |
最佳实践
- 明确命名频道: 使用
pr-{number}约定以便识别 - 自动清理: 总是删除通道当 PR 关闭
- 限制访问: 只在 debug/staging 构建中启用抖动菜单
- 文档过程: 将测试指令添加到您的 PR 模板
- 优雅地处理失败: 在发布评论之前检查通道创建是否成功
什么时候不使用 PR 预览
PR 预览适用于 JavaScript/CSS 变更。如果您的 PR 包含:
- 新 Capacitor 插件
- 上下文: HTML 文本片段来自更长的 Capgo UI 字符串 (父级键 `capwesome_diff_plugins_capgo`). 页面/区域: Capawesome 比较页面。角色: 长期营销或法律段落。见于: 页面 capwesome.astro。保留 Capgo 产品/品牌和开发者术语完全不变。消息键 `capwesome_diff_plugins_capgo` (Capwesome Diff Plugins Capgo). "iOS 原生 code 变更"
- Android 原生 code 变更
- 影响原生构建的依赖项更新
您需要传统的 TestFlight/Play Store 分发来实现这些变更。
与 Channel Surfing 结合使用
PR 预览在与 channel surfing一起使用时效果最佳。
production您的应用程序可以具有:beta- 对所有用户的稳定发布pr-123- 选择性用户的早期访问
- 特定 PR 的功能预览
具有生产构建的测试者可以切换到任何 PR 通道,测试功能,然后切回 - 所有这些都可以使用同一已安装的应用程序
结论
PR 预览将改变您的团队如何审阅和测试移动功能。您不再需要等待 TestFlight 处理和管理多个 beta 版本,测试人员可以在几秒钟内切换到任何 PR 频道,使用他们已经安装的应用程序。
设置很简单 - 只需要一个 GitHub Actions 工作流文件 - 利益会在您的团队中积累。QA 不会被阻塞,产品经理可以更快地审阅,开发人员可以更快地获得反馈。
首先将工作流添加到一个仓库中,看到它如何改变您的审阅流程。
继续阅读 Turn Every Pull Request Into an Installable Preview
如果您正在使用 Turn Every Pull Request Into an Installable Preview 为了规划频道路由和阶段性发布,连接它与 频道 频道 频道 频道 频道 Beta测试解决方案 为Beta测试解决方案中的产品工作流程,和 版本目标解决方案 为版本目标解决方案中的产品工作流程。 文章来源:Capgo