Capgo Integration with GitHub Actions: Guide

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

• 简化部署更新节省资金 : 与 AppFlow 相比，通过 CI/CD 可节省 5 年内最高 210100 元.
• 快速更新: 95% 的用户在 24 小时内接收更新
• 安全部署: 全程加密确保更新安全
• 流程化工作流：直接在您的GitHub仓库中自动化构建和部署。

快速概述

1. 需求：GitHub账户 Capgo账户 (from $12/month), Capacitor project, __CAPGO_KEEP_0__项目.
2. Node.js设置 Capgo CLI __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ 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 的集成 集成 GitHub Actions 需要设置必要的工具和配置。

所需工具和帐户

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

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

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

为了集成 Capgo, 在您的 Capacitor 项目中使用其 CLI 工具进行安装。根据马丁·多纳迪厄（Martin Donadieu）的说法，他是 Capgo 的创始人:

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

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

GitHub 仓库设置

为集成 CI/CD 而准备您的 GitHub 仓库，满足 Capgo 的要求。

在添加工作流之前，确认仓库具有所需的机密、 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:

管理密钥

为了确保安全的部署，您需要正确管理您的密钥。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 }}

确保您的更新在工作流运行时自动构建、版本化和部署。 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 的频道系统帮助您为不同阶段创建独立的部署路径：

错误解决方案

以下是常见的集成问题和解决方案:

1. 身份验证失败

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

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%，24小时内有95%的活跃用户接收到更新 [1], 这个解决方案以其高效性而闻名。

以下是一些亮点:

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

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

高级策略

为了充分利用Capgo和GitHub Actions的整合，以下是高级策略：

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