Capgo 与 GitHub Actions 的集成指南

Capgo 和 GitHub Actions 一起简化部署更新 Capacitor 节省资金

• : 比较到AppFlow 快速更新.
• : 95% 的用户在 24 小时内接收到更新。安全部署
• apps. 这是为什么这个集成值得你关注：确保更新安全的端到端加密
• 流程化工作流直接在您的GitHub仓库中自动构建和部署

快速概览

1. 需求GitHub账户 Capgo账户 (每月$12起始),Capacitor项目 Node.js.
2. 设置安装 Capgo CLI 与 npx @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 Actions 教程 - 基础概念和 CI/CD 管道

设置要求

与 Capgo 集成 with GitHub Actions involves setting up the necessary tools and configurations.

所需工具和账户

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

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

添加 Capgo 到您的项目

要集成 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工作流程，这将在下一节中详细介绍。

自动化您的 Capgo 部署 使用 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. 访问仓库设置
   前往您的仓库设置并找到“Secrets and variables”部分，位于“Security”选项卡下。

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

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

测试和修复

运行测试工作流

您可以通过使用专门的GitHub测试频道测试GitHub Actions 工作流。 Capgo的频道系统帮助您为不同阶段创建独立的部署路径:频道

- 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. 构建错误

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

“我们在生产环境中部署了 Capgo OTA 更新，我们的用户数量超过 5000。我们看到 OTA 部署后几乎所有用户都在几分钟内更新到最新版本。@Capgo” [1]

3. 版本冲突

遵循语义版本管理，并正确递增版本号以防止部署期间的冲突。

维护提示

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

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

结论

关键亮点

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

以下是一些亮点:

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

这些功能为更具定制化的解决方案和改进的性能打下了基础，具体内容请参见下文。

高级策略

为了最大限度地利用Capgo和GitHub Actions的整合，深入探索这些高级策略:

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

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

继续阅读 Capgo 与 GitHub 动作的集成指南

如果您正在使用 Capgo 与 GitHub 动作的集成指南 来规划安全性和合规性，请将其与 加密 在加密中实现详细信息 合规 在合规中实现详细信息 Capgo 安全扫描器 在 Capgo 安全扫描器中查看产品工作流 Capgo 安全 为 Capgo 安全 的产品工作流程 Capgo 信任中心 为 Capgo 信任中心 的产品工作流程