Skip to main content

Getting started with GitHub Actions for GitHub Enterprise Server

Learn about enabling and configuring GitHub Actions on GitHub Enterprise Server for the first time.

Site administrators can enable GitHub Actions and configure enterprise settings.

注: GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。 您可以在 GitHub 公共路线图 上查看有关未来支持计划的更多信息。

About GitHub Actions on GitHub Enterprise Server

This article explains how site administrators can configure GitHub Enterprise Server to use GitHub Actions.

GitHub Actions 在 GitHub Enterprise Server 3.0 或更高版本中可用。 如果您使用的是早期版本的 GitHub Enterprise Server,则必须升级才能使用 GitHub Actions。 有关升级 GitHub Enterprise Server 实例的更多信息,请参阅“关于升级到新版本”。

GitHub Actions is not enabled for GitHub Enterprise Server by default. You'll need to determine whether your instance has adequate CPU and memory resources to handle the load from GitHub Actions without causing performance loss, and possibly increase those resources. You'll also need to decide which storage provider you'll use for the blob storage required to store artifacts generated by workflow runs. Then, you'll enable GitHub Actions for your enterprise, manage access permissions, and add self-hosted runners to run workflows.

在开始之前,您应该制定一个计划,说明如何将 GitHub Actions 引入企业。 更多信息请参阅“为企业引入 GitHub Actions”。

如果要将企业迁移到来自其他提供商的 GitHub Actions,还有其他注意事项。 更多信息请参阅“将企业迁移到 GitHub Actions”。

Review hardware requirements

The CPU and memory resources available to 您的 GitHub Enterprise Server 实例 determine the number of jobs that can be run concurrently without performance loss. GitHub recommends a minimum of 8 vCPU and 64 GB memory to run GitHub Actions.

The peak quantity of concurrent jobs running without performance loss depends on such factors as job duration, artifact usage, number of repositories running Actions, and how much other work your instance is doing not related to Actions. Internal testing at GitHub demonstrated the following performance targets for GitHub Enterprise Server on a range of CPU and memory configurations:

vCPU内存最大并行数
32128 GB1000 个作业
64256 GB1300 个作业
96384 GB2200 个作业

Maximum concurrency was measured using multiple repositories, job duration of approximately 10 minutes, and 10 MB artifact uploads. You may experience different performance depending on the overall levels of activity on your instance.

If you plan to enable GitHub Actions for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of GitHub Enterprise Server, see "Monitoring your appliance."

For more information about minimum hardware requirements for 您的 GitHub Enterprise Server 实例, see the hardware considerations for your instance's platform.

有关为现有实例调整资源的更多信息,请参阅“增加存储容量”和“增加 CPU 或内存资源”。

External storage requirements

To enable GitHub Actions on GitHub Enterprise Server, you must have access to external blob storage.

GitHub Actions uses blob storage to store data generated by workflow runs, such as workflow logs and user-uploaded build artifacts. The amount of storage required depends on your usage of GitHub Actions. Only a single external storage configuration is supported, and you can't use multiple storage providers at the same time.

GitHub Actions supports these storage providers:

  • Azure Blob storage
  • Amazon S3
  • S3-compatible MinIO Gateway for NAS

Note: These are the only storage providers that GitHub supports and can provide assistance with. Other S3 API-compatible storage providers are unlikely to work due to differences from the S3 API. Contact us to request support for additional storage providers.

警告:MinIO 已宣布删除 MinIO 网关。 从 2022 年 6 月 1 日开始,当前 MinIO NAS 网关实施的支持和错误修复将仅提供给通过其 LTS 支持合同的付费客户。 如果要继续将 MinIO 网关与 GitHub Actions 配合使用,我们建议您迁移到 MinIO LTS 支持。 更多信息请参阅 minio/minio 存储库中计划删除适用于 GCS、Azure、HDFS 的 MinIO 网关

Before you enable GitHub Actions, you can test your storage configuration from the administrative shell with the ghe-actions-precheck utility. For more information, see "Command-line utilities" and "Accessing the administrative shell (SSH)."

Networking considerations

如果为企业启用了 GitHub Actions ,则仅支持 HTTP 代理。 不支持 SOCK5 和 HTTPS 代理以及 Polipo。 For more information about using a proxy with GitHub Enterprise Server, see "Configuring an outbound web proxy server."

Enabling GitHub Actions with your storage provider

Follow one of the procedures below to enable GitHub Actions with your chosen storage provider:

Managing access permissions for GitHub Actions in your enterprise

You can use policies to manage access to GitHub Actions. For more information, see "Enforcing GitHub Actions policies for your enterprise."

Adding self-hosted runners

注: GitHub 托管的运行器目前在 GitHub Enterprise Server 上不受支持。 您可以在 GitHub 公共路线图 上查看有关未来支持计划的更多信息。

To run GitHub Actions workflows, you need to add self-hosted runners. You can add self-hosted runners at the enterprise, organization, or repository levels. For more information, see "Adding self-hosted runners."

Managing which actions can be used in your enterprise

You can control which actions your users are allowed to use in your enterprise. This includes setting up GitHub Connect for automatic access to actions from GitHub.com, or manually syncing actions from GitHub.com.

For more information, see "About using actions in your enterprise."

GitHub Actions 的一般安全性增强

如需了解有关 GitHub Actions 安全实践的更多信息,请参阅“GitHub Actions 的安全性增强”。

Reserved names

When you enable GitHub Actions for your enterprise, two organizations are created: github and actions. If your enterprise already uses the github organization name, github-org (or github-github-org if github-org is also in use) will be used instead. If your enterprise already uses the actions organization name, github-actions (or github-actions-org if github-actions is also in use) will be used instead. Once actions is enabled, you won't be able to use these names anymore.