Capgo 与 GitHub 的集成指南：操作指南

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

• 节省资金: 比 AppFlow 节省 5 年内的 CI/CD 成本高达 $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管道

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 分析 监控更新成功率。
• 启用可能导致问题的更新的自动回滚功能。
• 使用渠道选择器测试拉取请求（PR）以获得更好的控制。
• 保持您的工作流程与最新的Capgo CLI命令同步。

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

结论

关键亮点

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

以下是一些亮点:

• 自动化工作流程:通过在GitHub Actions中配置工作流程，无需使用外部CI/CD托管。这一方法可以节省约$26,100的运营成本，相比之下，AppFlow等替代方案需要更长时间 [1].
• 快速部署:更新可以立即推送，绕过应用商店延迟
• 强大的安全性：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.

继续从 Capgo 与 GitHub 的集成中

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