Skip to main content

在工作流中使用自托管运行程序

要在工作流程中使用自托管的运行器,您可以使用标签为作业指定运行器类型。

注意:GitHub Enterprise Server 目前不支持 GitHub 托管的运行器。 可以在 GitHub public roadmap 上查看有关未来支持计划的更多信息。

有关创建自定义和默认标签的信息,请参阅“将标签与自托管运行器一起使用”。

在工作流中使用自托管运行程序

标签允许您根据其共同特征向特定类型的自托管运行器发送工作流程作业。 例如,如果您的作业需要特定的硬件组件或软件包。 您可以将一个自定义标签分配给运行器,然后将您的作业配置为仅在带该标签的运行器中执行。

要为作业指定自托管运行器,请在工作流文件中使用自托管运行器标签配置 runs-on

所有自托管运行器都有 self-hosted 标签。 仅使用此标签将选择任何自托管运行器。 选择符合特定条件的运行器,例如操作系统或体系结构,建议提供以 self-hosted 开头的标签数组(必须首先列出),然后根据需要包含其他标签。 指定标签数组时,作业将在具有你指定的所有标签的运行器上排队。

尽管 self-hosted 标签不是必需的,但强烈建议在使用自托管运行器时指定它,以确保作业不会无意中指定任何当前或将来的 GitHub 托管运行器。

有关详细信息,请参阅“GitHub Actions 的工作流语法”。

使用默认标签路由作业

在被添加到 GitHub Actions 后,自托管运行器将自动收到某些标签。 这些被用于指出其操作系统和硬件平台:

  • self-hosted:应用于所有自托管运行器的默认标签
  • linuxwindowsmacOS:根据操作系统应用。
  • x64ARMARM64:根据硬件体系结构应用。

您可以使用您工作流程的 YAML 将作业发送到这些标签的组合。 在此示例中,与所有三个标签匹配的自托管运行器将有资格运行该作业:

runs-on: [self-hosted, linux, ARM64]
  • self-hosted - 在自托管运行器上运行此作业。
  • linux - 仅使用基于 Linux 的运行器。
  • ARM64 - 仅使用基于 ARM64 硬件的运行器。

默认标签是固定的,无法更改或删除。 如果您需要对作业路由的更多控制,考虑使用自定义标签。

使用自定义标签路由作业

您可以随时创建自定义标签并将其分配给您的自托管运行器。 自定义标签允许您根据其标注将作业发送给特定的自托管运行器类型。

例如,如果某个作业需要特定类型的图形硬件,则可以创建名为 gpu 的自定义标签,并将其分配给安装了该硬件的运行器。 然后,与所有已分配的标签匹配的自托管运行器将有资格运行该作业。

此示例显示组合默认标签和自定义标签的作业:

runs-on: [self-hosted, linux, x64, gpu]
  • self-hosted - 在自托管运行器上运行此作业。
  • linux - 仅使用基于 Linux 的运行器。
  • x64 - 仅使用基于 x64 硬件的运行器。
  • gpu - 此自定义标签已被手动分配给安装了 GPU 硬件的自托管运行器。

这些标签累计运行,所以自托管运行器必须拥有所有四个标签才能处理该作业。

自托管运行器的路由优先级

将作业路由到自托管运行器时,GitHub 将查找与作业的 runs-on 标签匹配的运行器:

  • 如果 GitHub 找到一个在线的空闲运行器与作业的 runs-on 标签匹配,则作业将分配并发送到该运行器。
    • 如果运行器在 60 秒内未收到分配的任务,任务将被重新排队,以便新的运行器能够接纳它。
  • 如果 GitHub 找不到与作业的 runs-on 标签匹配的在线和空闲运行器,则作业将继续排队,直到某个运行器上线为止。
  • 如果作业排队的时间超过 24 小时,则作业将失败。