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

Capgo 和 GitHub 动作集成 简化部署更新的过程 Capacitor 节省资金：通过减少CI/CD成本，节省每5年$26,100美元，相比于AppFlow

• 快速更新节省资金：通过减少CI/CD成本，节省每5年$26,100美元，相比于AppFlow 快速更新.
• 节省资金：通过减少CI/CD成本，节省每5年$26,100美元，相比于AppFlow: 立即推送更新，95% 的用户在 24 小时内接收到它们。
• 安全部署: 使用端到端加密确保更新是安全的。
• 流程化工作流: 在您的 GitHub 仓库中直接自动化构建和部署。

快速概览

1. 需求: GitHub 账户， Capgo 账户 (每月 $12 起)，Capacitor 项目， Node.js.
2. 设置: 安装 Capgo CLI 与 npx @capgo/cli init, 使用 YAML 工作流程配置 GitHub 动作。
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 动作集成涉及设置必要的工具和配置。

所需工具和帐户

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

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

添加 Capgo 到你的项目

为了集成Capgo，使用Capacitor项目中的CLI工具安装它。根据Martin Donadieu，Capgo的创始人：

“运行npx @capgo/cli init它！” [1]

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

GitHub仓库设置

为集成Capgo的CI/CD准备你的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 集成 同时保持安全性。

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

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. 访问仓库设置
   转到您的仓库设置并在“安全”选项卡下的“机密和变量”部分找到。

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 身份验证

Securely authenticate the CLI using the 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 Actions 工作流来测试GitHub Capgo测试频道. 这样可以在更新发布之前验证更新。

- name: Test Build Deployment
  run: |
    npx @capgo/cli build
    npx @capgo/cli deploy --channel beta
  env:
    CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }}

Capgo的频道系统帮助您为不同阶段创建不同的部署路径：

错误解决方案

Here are some common integration issues and how to address them:

1. 认证失败

检查 CAPGO_TOKEN 在 GitHub 秘密中。如果它过期，请重新生成它以确保平滑的认证。

2. 构建错误

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

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

3. 版本冲突

坚持语义版本和正确地递增版本以防止在部署期间发生冲突。

维护提示

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

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

结论

关键亮点

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

以下是一些亮点功能：

• 自动工作流程: 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].
• 快速部署: 更新可以立即推送，绕过应用商店延迟。
• 强大的安全性: 从源头到终点的加密确保更新安全传输，Capgo 的通道系统允许控制、分阶段的发布。

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

高级策略

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

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

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

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

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