使用 Expo GitHub App 触发构建

编辑页面

了解如何使用 Expo GitHub App 为你的应用在 EAS 上触发构建。

本指南说明如何使用 Expo GitHub App 直接从你的 GitHub 仓库触发构建。

前提条件

在你的 eas.json 中设置 `image` 字段

对于你希望与 GitHub 一起使用的构建配置文件，请在 eas.json 中为原生平台指定要使用的 image。

如果你的项目配置不依赖于特定的构建镜像，请使用 latest 镜像。例如：

eas.json

{
  %%placeholder-start%%... %%placeholder-end%%
  "build": {
    "production": {
      "android": {
        "image": "latest"
      },
      "ios": {
        "image": "latest"
      }
    }
  }
}

在本地机器上成功运行一次构建

要从 GitHub 仓库触发 EAS 构建，你需要先为项目配置好 EAS Build，并且在你的电脑上成功为你希望在 GitHub 上支持的每个平台运行一次构建。

如果你还没有成功运行过 eas build -p [all|ios|android]，请查看创建你的首次构建了解更多信息。一旦完成，请继续阅读本指南中的步骤。

以下条件也必须满足：

组织中的 Expo 用户必须拥有一个已关联、且对目标仓库有访问权限的 GitHub 用户。请检查 Account settings > Overview > User settings > Connections，并确认你的 GitHub 用户账号已关联。
你必须接受 Expo GitHub app 请求的权限。

为 GitHub 配置你的应用

将你的 GitHub 仓库关联到 Expo 项目

访问你项目的GitHub 设置。

在你的 GitHub 账号上安装 Expo GitHub App。

注意：你必须拥有 Expo 账号的 Owner 或 Admin 访问权限才能安装该应用。

然后，将 GitHub 仓库关联到你的 Expo 项目。

注意：你只能将 GitHub 组织仓库关联到 Expo 组织。

如需从另一个 GitHub 账号添加仓库，请在账号选择下拉菜单中点击 Add new account 选项。

配置你的仓库设置

在运行构建之前，Expo GitHub App 需要知道在哪里找到你项目的源代码。如果你的 Expo 项目源代码位于仓库根目录，那么你无需做任何操作。如果你的 Expo 项目源代码位于子目录中，那么你需要在项目的GitHub 设置页面为你的仓库配置“Base directory” 设置。

Expo 项目 GitHub 设置页面上的 base directory 输入框

从 GitHub 触发构建

当你为 GitHub 配置好应用后，你可以使用项目构建列表页面上的 UI 或通过 GitHub PR 上的标签来从 GitHub 触发构建。

使用 Expo 网站构建

访问你项目的构建列表页面，然后点击“Build from GitHub”按钮。系统会提示你选择一个 Git ref（branch/commit/tag）、要构建的平台，以及要应用的构建配置文件。

你也可以为这次特定构建指定一个 base directory。这不会更改该项目的全局设置。

使用 GitHub PR 标签构建

你可以通过给 GitHub PR 添加标签来触发构建。标签必须采用 eas-build-[platform]:[profile] 的形式，其中 [platform] 可以是 android、ios 或 all，而 [profile] 是你在 eas.json 文件中指定的构建配置文件名称。如果你不指定构建平台，默认值为 all。如果你不指定构建配置文件，默认值为 production。

例如，如果你想触发一个 Android 的生产构建，请给 PR 添加标签 eas-build-android。

构建将针对 PR 基础分支上的最新提交触发。你可以在 PR 的 checks 中查看构建状态。构建链接会显示在该 check 的详情中。

当代码推送到你的 GitHub 仓库时自动构建

你可以进一步实现构建自动化，当你向 GitHub 推送代码时自动构建你的 Expo 项目。

使用 EAS Workflows

EAS Workflows 是 Expo 提供的一项服务，允许你在 EAS 上运行构建以及许多其他类型的作业。你可以使用 EAS Workflows 来自动化开发和发布流程，例如创建开发构建或自动构建并提交到应用商店。

要使用 EAS Workflows 创建构建，请先在 .eas/workflows/build.yml 中添加以下代码：

.eas/workflows/build.yml

name: Build

on:
  push:
    branches:
      - main

jobs:
  build_android:
    name: Build Android App
    type: build
    params:
      platform: android
  build_ios:
    name: Build iOS App
    type: build
    params:
      platform: ios