Capgo与GitHub集成指南

Capgo 和 GitHub Actions 共同简化应用更新的部署 Capacitor apps. 这是为什么这个集成值得你关注的原因:

• 节省资金: 与其他方案相比，通过 5 年内节省至多 $26,100 的 CI/CD 成本 AppFlow.
• 快速更新: 在 24 小时内，95% 的用户可以立即接收更新。
• 安全的部署: 从头到尾的加密确保更新是安全的。
• 流程化的工作流: 在你的 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 动作 教程 - 基本概念和 CI/CD pipeline

设置要求

集成 Capgo 与 GitHub Actions 相关的设置涉及配置必要的工具和设置。

所需工具和帐户

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

一旦这些准备就绪，您就可以添加 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.

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

定价

• Capgo 计划从每月 12 美元开始。
• 同一计划包括 OTA 更新和每月约 15 个本机构建。
• 额外的构建分钟通过积分计费。

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

• 仓库结构: 将您的仓库组织为单独的目录来存储源 code、资产和配置文件，以保持一切清洁和可管理。
• 环境配置: 为开发、测试和生产环境创建不同的环境，确保正确的访问控制和安全措施已实施。
• 访问管理: 小心设置存储库权限，以允许 Capgo 集成 同时保持安全性。

这些步骤将确保您的项目已准备好使用 GitHub Actions 工作流，这将在下一节中详细介绍。

GitHub Actions 工作流设置

使用 __CAPGO_KEEP_0__ Actions Capgo deployments GitHub 部署

以简化您的 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 命令集成到GitHub 中来自动化部署。

安装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的秘密管理系统在整个过程中保持您的凭证安全。

测试和修复

运行测试工作流

You can test your GitHub Actions workflow by using a dedicated 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. 构建错误

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

“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的集成与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%，24小时内有95%的活跃用户接收更新

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].
• Fast Deployment自动化工作流程
• ：通过在__CAPGO_KEEP_0__ Actions中配置工作流程，无需使用外部CI/CD托管。这一方法可以节省约$26,100的运营成本，相比之下，AppFlow等替代方案需要更高的成本: End-to-end encryption ensures updates are delivered securely, while Capgo’s channel system allows for controlled, staged rollouts.

快速部署

Advanced Strategies

为了充分利用您的Capgo和GitHub Actions 集成，探索这些高级策略：

• Custom API Workflows：使用Capgo的公共API来设计符合团队特定需求的部署工作流程。这可以实现白标签体验和与当前工具的无缝集成 [1].
• Channel-Based Releases：通过使用Capgo的通道功能来优化您的部署过程，实现分阶段和受控的更新
• Optimized Performance：利用Capgo的部分更新来减少带宽使用和加速更新。通过在750个生产应用中交付23.5万次更新，系统已经证明了其处理大规模需求的能力 [1]为了获得更好的结果，请考虑使用__CAPGO_KEEP_0__的自主托管选项或自定义__CAPGO_KEEP_1__设置。查看早期部分以获取详细的设置和测试指南，以完全实施这些策略

继续阅读Capgo集成API Actions：指南

如果您正在使用Capgo集成GitHub Actions，继续阅读指南。

__CAPGO_KEEP_0__集成__CAPGO_KEEP_1__ Actions指南 Capgo 与 GitHub 的集成：指南 规划安全性和合规性，连接它 加密 加密的实施细节 合规 合规的实施细节 Capgo 安全扫描器 Capgo 安全扫描器的产品工作流程 Capgo 安全 Capgo 安全的产品工作流程 Capgo 信任中心 Capgo 信任中心的产品工作流程