跳过主要内容

Capgo 与 GitHub 集成指南

与 Capgo 集成 GitHub Actions,实现高效、安全和成本低廉的应用更新,优化您的开发流程。

马丁·多纳迪厄

马丁·多纳迪厄

内容营销人员

Capgo 与 GitHub Actions 的集成指南

CapgoGitHub Actions 一起简化应用更新的部署。以下是为什么这个集成值得您的关注: Capacitor __CAPGO_KEEP_0__

  • __CAPGO_KEEP_1__: 根据预测,5年内可节省至多 26,100 美元的CI/CD成本 AppFlow.
  • 快速更新: 95% 的用户在 24 小时内接收到更新
  • 安全部署: 从源到端的加密确保更新的安全
  • 流程简化: 直接在您的 GitHub 仓库中自动构建和部署

快速概览

  1. 需求: GitHub 账户 Capgo 账户 (从 $12/月起), Capacitor 项目, Node.js.
  2. 设置: 安装 Capgo CLInpx @capgo/cli init, 配置 GitHub Actions 使用 YAML 工作流。
  3. 部署: 使用命令 npx @capgo/cli deploy自动化更新.
  4. 测试在测试环境(如beta,staging)中部署之前,测试。

示例工作流程 (YAML):

name: Capgo Deploy  
on:  
  push:  
    branches:  
      - main  

jobs:  
  deploy:  
    runs-on: ubuntu-latest  
    steps:  
      - uses: actions/checkout@v6  
      - uses: actions/setup-node@v3  
        with:  
          node-version: '24'  
      - name: Install Dependencies  
        run: npm install  
      - name: Deploy to Capgo  
        run: npx @capgo/cli deploy  
        env:  
          CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}  

快速、安全、经济的应用程序更新,这使其成为敏捷开发团队的理想选择。

GitHub 操作 教程 - 基础概念和 CI/CD pipeline

GitHub 操作

设置要求

将Capgo集成到应用中 使用 GitHub Actions涉及设置必要的工具和配置。

必备工具和账户

确保您已经准备好以下账户和工具:

需求目的详细信息
GitHub 账户版本控制 & CI/CD拥有访问仓库的活跃账户
Capgo 账户管理实时更新计划从 SOLO 计划开始,月费 $12
Capacitor 项目应用开发可用于集成的功能项目
Node.js运行时环境建议使用最新的长期支持版本

一旦这些设置完成,您就可以继续将 Capgo 添加到您的项目中,实现自动实时更新。

添加 Capgo 将 Capgo 添加到您的项目

Capgo 实时更新控制台界面

在集成 Capgo 时,请在您的 Capacitor 项目中使用其 CLI 工具。根据马丁·多纳迪乌(Martin Donadieu)的话,Capgo 的创始人说:

“使用 npx @capgo/cli init 命令吧!” [1]

本命令将设置插件及其所需的依赖项。

GitHub 仓库设置

Prepare your GitHub repository to meet the requirements for CI/CD integration with Capgo. As mentioned in their documentation:

“We configure your CI/CD pipeline directly in your preferred platform, whether it’s GitHub Actions, GitLab CI, or others. We don’t host CI/CD or charge you to maintain it.” [1]

Capgo offers OTA updates from $12/month, which is more affordable compared to AppFlow’s $6,000 annual fee [1]

  • : Organize your repository with separate directories for source code, assets, and configuration files to keep everything clean and manageable.
  • Capgo integration

这些步骤将确保您的项目准备好使用GitHub Actions工作流程,这将在下一节中详细说明。

GitHub Actions工作流程设置

自动化您的 Capgo 部署 使用GitHub Actions来简化您的CI/CD流程。

创建工作流文件

首先,在您的仓库的 .github/workflows 目录中创建一个YAML文件。以下是一个示例:

name: Capgo Deploy
on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v3
        with:
          node-version: '24'
      - name: Install Dependencies
        run: npm install
      - name: Build App
        run: npm run build
      - name: Deploy to Capgo
        run: npx @capgo/cli deploy
        env:
          CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}

此配置确保了安全和自动化的部署。设置文件后,请选择合适的触发器来启动工作流。

工作流触发器选项

GitHub Actions允许您自定义工作流何时运行。以下是触发器选项:

触发类型用例配置
推送事件在 code 上发布更改code 的特定分支推送时激活
手动分发按需更新允许您手动启动工作流
计划定时发布按照设置的时间间隔运行部署
Pull Request浏览程名前模式浏览程名前模式仅我下一个浏览程名前模式为一布程名前模式

管理通常码

To ensure secure deployments, you need to manage your secret keys properly. GitHub Actions offers an encrypted secrets management system for this purpose.

说常程名前模式的说常程名前模式

  1. 说常程名前模式为一布程名前模式
    给安全安全程名前模式的程名前模式为一布程名前模式

  2. 说常程名前模式为一布程名前模式 Capgo Credentials
    Save your Capgo authentication token as a repository secret. Name it CAPGO_TOKEN.

  3. 程名前模式为一布程名前模式
    使用存储的密钥在工作流中引用它们,如下所示: ${{ secrets.CAPGO_TOKEN }}.

Capgo 工作流命令

设置了 GitHub Actions 环境后,您可以通过将 Capgo CLI 命令集成到自动部署中。

安装 Capgo CLI

将以下步骤添加到您的工作流中以安装 Capgo CLI:

steps:
  - name: Install Capgo CLI
    run: npm install -g @capgo/cli
  - name: Initialize Capgo
    run: npx @capgo/cli init

认证 CLI

使用以下方法安全地认证 CLI CAPGO_TOKEN:

- name: Authenticate Capgo CLI
  run: npx @capgo/cli login
  env:
    CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}

部署命令

以下是处理构建、版本化和部署更新的关键命令:

命令目的使用示例
build生成一个 生产就绪的捆绑包npx @capgo/cli build
deploy推送更新到 Capgonpx @capgo/cli deploy
version设置更新的版本npx @capgo/cli version 1.2.0

为了自动化整个部署流程,请使用命令组合如下:

steps:
  - name: Build and Deploy
    run: |
      npx @capgo/cli build
      npx @capgo/cli version ${{ github.ref_name }}
      npx @capgo/cli deploy
    env:
      CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}

这种设置确保您的更新在工作流运行时自动构建、版本化和部署。 GitHub 的秘密管理系统在整个过程中保护您的凭证安全。

测试和修复

运行测试工作流

您可以通过使用专门的 GitHub Actions 工作流来测试您的 GitHub Capgo 测试频道。这使您能够在更新发布之前验证更新。

- name: Test Build Deployment
  run: |
    npx @capgo/cli build
    npx @capgo/cli deploy --channel beta
  env:
    CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}

Capgo 的频道系统帮助您为不同阶段创建独立的部署路径:

频道目的目标受众
测试版内部团队测试环境
QA 验证测试用户生产环境
实时部署所有用户所有用户

错误解决方案

以下是常见的集成问题和解决方案: 1.

1. 认证失败

检查 CAPGO_TOKEN 在 GitHub 秘钥中。如果它已经过期,请重新生成它以确保身份验证顺畅。

2. 错误构建

确保您的构建配置符合您的部署环境的要求。

“我们在生产环境中部署了Capgo OTA更新,覆盖了5000多名用户。我们看到 OTA部署到@Capgo后,大部分用户在几分钟内都能及时更新。” [1]

3. 版本冲突

遵循语义版本控制,并正确增量版本号,以避免部署期间的冲突。

维护提示

  • 使用Capgo Capgo 分析 监控更新成功率。
  • 为可能导致问题的更新启用自动回滚。
  • 使用渠道选择器测试拉取请求(PR)以获得更好的控制。
  • 通过使用最新的 Capgo CLI 命令来保持您的工作流程最新。

对于高优先级部署,利用 Capgo 的错误跟踪功能尽早发现潜在问题。如果出现问题,回滚功能可以快速切换到稳定版本,减少中断。这些实践将有助于在接近生产环境时保持您的部署顺利。

结论

关键亮点

Capgo 的集成与 GitHub Actions 简化了部署过程 Capacitor 应用程序,为开发团队带来了重大优势。全球更新成功率达82%,95%的活跃用户在24小时内接收到更新 [1]

以下是一些亮点:

  • 自动化工作流程:通过在GitHub Actions中配置工作流程,无需使用外部CI/CD托管。这一方法可以节省约5年内的运营成本,相比之下,像AppFlow这样的替代方案每年节省约$5,210 [1].
  • 快速部署:更新可以立即推送,绕过应用商店延迟。
  • 强大的安全性:端到端的加密确保更新被安全地传递,而Capgo的通道系统允许控制、分阶段的发布。

这些功能为更具定制化的解决方案和改进的性能奠定了基础,具体细节请参见下文。

高级策略

为了充分利用Capgo和GitHub Actions的集成,探索以下高级策略:

  • 自定义API工作流:使用Capgo的公共API来设计符合团队具体需求的部署工作流程。这可以实现白标应用和与当前工具的无缝集成 [1].
  • 基于通道的发布使用Capgo的频道功能来优化您的部署流程,实现分阶段和控制的更新。
  • 高效性能: 利用Capgo的部分更新来减少带宽使用量并加快更新速度。通过 750 个生产应用程序交付了 2350 万次更新 [1]该系统已经证明了其处理大规模需求的能力。

为了获得更好的结果,请考虑使用Capgo的自主托管选项或自定义API设置。请参阅前面的部分以获取详细的设置和测试说明,以完全实施这些策略。

实时更新Capacitor应用

当web层bug处于活跃状态时,通过Capgo将修复推送到应用,而不是等待几天的应用商店审批。用户在后台接收更新,而原生变化保持在正常的审批路径中。

立即开始

最新博客文章

Capgo为您提供创建真正专业的移动应用所需的最佳见解。