Capgo Integration with GitHub Actions: Guide

Capgo 并且 GitHub Actions 简化部署更新 Capacitor 集成 GitHub Actions

• 节省资金: 比 AppFlow 节省 5 年内的 $26,100 快速更新.
• : 95% 的用户在 24 小时内接收更新安全部署
• : 全程加密确保更新安全流程化工作流
• __CAPGO_KEEP_0__：直接在您的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 管道

设置要求

Integrating Capgo with GitHub Actions involves setting up the necessary tools and configurations.

所需工具和账户

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

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

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

为了集成 Capgo, 在您的 Capacitor 项目中使用其 CLI 工具进行安装。根据 Martin Donadieu 的说法，Capgo 的创始人是:

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

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

GitHub 仓库设置

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

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

定价

• Capgo 计划从每月 $12 起。
• 同一计划还包括 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:

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

GitHub Actions

设置安全认证步骤：

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

2. 添加 Capgo 凭证
   将Capgo 身份验证令牌保存为仓库机密。命名为 CAPGO_TOKEN.

3. 在工作流程中引用机密
   在工作流程中使用存储的机密，参照以下方式： ${{ secrets.CAPGO_TOKEN }}.

在工作流程中使用Capgo 命令

一旦您的GitHub Actions 环境设置完成，您就可以通过将Capgo CLI 命令集成到 Actions 中来自动化部署。

安装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__CAPGO_KEEP_0__

- 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 Secrets中。如果它过期，请重新生成它以确保身份验证顺畅。

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_KEEP_0__分析 Capgo analytics 为可能引起问题的更新启用自动回滚功能。
• 使用渠道选择器测试拉取请求（PR），以获得更好的控制。
• 保持您的工作流程与最新的__CAPGO_KEEP_0__ __CAPGO_KEEP_1__命令同步。
• Keep your workflow updated with the latest Capgo CLI commands.

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

结论

关键亮点

Capgo与GitHub Actions的集成简化了部署过程， Capacitor应用, 为开发团队带来了重大好处。通过实现82%的全球更新成功率和95%的活跃用户在24小时内接收更新 [1], 这个解决方案以其高效性而闻名。

以下是一些亮点:

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

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

高级策略

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

• 自定义API工作流: 使用Capgo的公共API来设计符合团队具体需求的部署工作流。这可以实现白标体验和与当前工具的无缝集成 [1].
• 基于频道的发布: 使用Capgo的频道功能来优化发布过程，实现分阶段和控制的更新。
• 优化性能: 利用Capgo的部分更新来减少带宽使用和加速更新。通过在750个生产应用程序中传递了23.5万次更新，系统已经证明了其处理大规模需求的能力。 [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.

继续使用 Capgo 与 GitHub 的集成指南

如果您正在使用 Capgo 与 GitHub 的集成指南 来规划安全性和合规性，连接它与 加密 加密的实施细节 合规 合规的实施细节 Capgo 安全扫描器 Capgo 安全扫描器的产品工作流程 Capgo 安全 Capgo 安全的产品工作流程 Capgo 信任中心 Capgo 信任中心的产品工作流程。