Capgo 与 GitHub 的集成指南

Capgo 和 GitHub Actions 一起简化部署更新的过程 Capacitor 为什么这个集成值得你关注：

• 节省成本: 与 AppFlow 相比，通过 CI/CD 可以节省 5 年内 26,100 美元的成本 快速更新.
• : 使用 95% 的用户在 24 小时内接收更新安全部署
• : 全链路加密确保更新是安全的流程化工作流
• Streamlined Workflow: 在您的 GitHub 仓库中直接自动化构建和部署。

快速概览

1. 要求: GitHub 账户, Capgo 账户 (每月 $12 起), Capacitor 项目, Node.js.
2. 设置: 安装 Capgo CLI 并 npx @capgo/cli init, 使用 YAML 工作流程配置 GitHub Actions。
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

Setup Requirements

在Capgo中集成Capgo 集成GitHub Actions涉及设置必要的工具和配置。

所需工具和帐户

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

一旦这些准备就绪，您就可以将 Capgo 添加到您的项目中，实现自动实时更新。

添加 Capgo 到您的项目

To integrate Capgo, install it in your Capacitor project using its CLI tool. According to Martin Donadieu, founder of Capgo:

“运行 npx @capgo/cli init 啦！” [1]

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

GitHub 仓库设置

为集成 CI/CD 与 Capgo 而准备您的 GitHub 仓库。

在添加工作流之前，请确认仓库具有所需的机密、 branch 保护和部署触发器以支持您的 OTA 发布过程。

定价

• Capgo plans start at $12/month.
• 同一计划包括 OTA 更新和每月约 15 个本机构建。
• 额外的构建分钟通过信用额度按分钟计费。

以下是如何设置您的仓库：

• 仓库结构: Organize your repository with separate directories for source code, assets, and configuration files to keep everything clean and manageable.
• 环境配置: 为开发、测试和生产环境创建不同的环境，确保正确的访问控制和安全措施。
• 访问管理: 小心设置仓库权限，允许 Capgo 集成

These steps will ensure your project is ready for the GitHub Actions workflow, which will be outlined in the next section.

GitHub Actions Workflow Setup

__CAPGO_KEEP_0__ Capgo deployments 使用 GitHub Actions 来简化您的 CI/CD 流程。

创建工作流文件

首先，在您的仓库目录中创建一个 YAML 文件。以下是一个示例： .github/workflows 此配置确保了安全和自动化的部署。设置文件后，请选择合适的触发器来启动工作流。

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 }}

工作流触发器选项

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

GitHub Actions allows you to customize when workflows run. Here are some trigger options:

管理机密密钥

为了确保安全的部署，需要正确管理机密密钥。 GitHub Actions 提供了加密的机密密钥管理系统来实现此目的。

安全认证设置步骤：

1. 访问仓库设置
   前往您的仓库设置，找到“安全”标签下的“密钥和变量”部分。

2. 添加 Capgo 凭证
   将您的 Capgo 认证令牌保存为仓库密钥。命名为 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 }}

部署命令

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

为了自动化整个部署过程，请将命令一起使用，如下所示：

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 }}

This setup ensures that your updates are automatically built, versioned, and deployed whenever the workflow runs. GitHub’s secret management system keeps your credentials safe throughout the process.

安全管理系统

测试和修复

You can test your GitHub Actions workflow by using a dedicated Capgo testing channel测试

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

Capgo’s channel system helps you create separate deployment paths for different stages:

错误解决方案

以下是某些常见的集成问题和解决方案：

1. 身份验证失败

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

2. 构建错误

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

“We rolled out Capgo OTA updates in production for our user base of +5000. We’re seeing very smooth operation almost all our users are upto date within minutes of the OTA being deployed to @Capgo.” [1]

3. 版本冲突

遵循语义版本管理，正确更新版本以避免部署期间的冲突。

维护提示

• 使用 Capgo 分析 监控更新成功率。
• 为可能引起问题的更新启用自动回滚功能。
• 使用渠道选择器测试 pull 请求（PR），以获得更好的控制。
• 保持您的工作流程与最新的 Capgo CLI 命令同步。

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

结论

关键亮点

Capgo’s integration with GitHub Actions 简化了部署流程 Capacitor 应用, delivering major benefits to development teams. With an 82% global success rate for updates and 95% of active users receiving updates within 24 hours [1]通过实现82%的全球更新成功率和95%的活跃用户在24小时内接收更新

Here are some standout features:

• 以下是一些亮点:: By configuring workflows directly in GitHub Actions, there’s no need for external CI/CD hosting. This approach cuts operational costs, saving about $26,100 over five years compared to alternatives like AppFlow [1].
• :通过在__CAPGO_KEEP_0__ Actions中配置工作流程，无需使用外部CI/CD托管。这一方法可以节省约$26,100的运营成本，相比使用AppFlow等替代方案快速部署
• :更新可以立即推送，绕过应用商店延迟: Capgo确保更新以安全的方式传递，Capgo的频道系统允许控制和分阶段的发布。

这些功能为更具针对性的解决方案和改进的性能奠定了基础，以下内容将进一步探讨。

高级策略

为了最大限度地利用Capgo和GitHub Actions集成，探索以下高级策略：

• 自定义API工作流: 使用Capgo的公共API来设计符合团队特定需求的部署工作流。这可以实现白标体验和与当前工具的无缝集成。 [1].
• 基于频道的发布: 使用Capgo的频道功能来优化发布过程，实现分阶段和控制的更新。
• 优化性能: 利用Capgo的部分更新来减少带宽使用和加速更新。通过在750个生产应用中传递了2,350万次更新，系统已经证明了其处理大规模需求的能力。 [1]为了获得更好的结果，请考虑使用__CAPGO_KEEP_0__的自主托管选项或自定义__CAPGO_KEEP_1__设置。请参阅早期部分以获取详细的设置和测试指南，以全面实施这些策略。

For even better results, consider using Capgo’s self-hosting options or custom API setups. Check earlier sections for detailed setup and testing instructions to fully implement these strategies.