跳到主要内容

GitHub

Woodpecker 内置支持 GitHub 和 GitHub Enterprise。 要将 Woodpecker 与 GitHub 一起使用，应为服务器组件设置以下环境变量：

WOODPECKER_GITHUB=true
WOODPECKER_GITHUB_CLIENT=YOUR_GITHUB_CLIENT_ID
WOODPECKER_GITHUB_SECRET=YOUR_GITHUB_CLIENT_SECRET

当您在 GitHub 中注册 OAuth 应用程序时，您将从 GitHub 获得这些值。 为此，请转到 Settings -> Developer Settings -> GitHub Apps -> New Oauth2 App。

注意

不要使用 "GitHub App" 而不是 Oauth2 应用，因为前者现在无法与 Woodpecker 正常工作（因为用户访问令牌不会自动刷新）

应用设置​

客户端密钥创建​

创建应用后，您可以生成客户端密钥。 将此密钥用于 WOODPECKER_GITHUB_SECRET 环境变量。

配置​

这是配置选项的完整列表。请注意，这些选项中的许多使用默认配置值，应该适用于大多数安装。

GITHUB​

  • 名称：WOODPECKER_GITHUB
  • 默认值：false

启用 GitHub 驱动程序。

GITHUB_URL​

  • 名称：WOODPECKER_GITHUB_URL
  • 默认值：https://github.com

配置 GitHub 服务器地址。

GITHUB_CLIENT​

  • 名称：WOODPECKER_GITHUB_CLIENT
  • 默认值：无

配置 GitHub OAuth 客户端 ID 以授权访问。

GITHUB_CLIENT_FILE​

  • 名称：WOODPECKER_GITHUB_CLIENT_FILE
  • 默认值：无

从指定的文件路径读取 WOODPECKER_GITHUB_CLIENT 的值。

GITHUB_SECRET​

  • 名称：WOODPECKER_GITHUB_SECRET
  • 默认值：无

配置 GitHub OAuth 客户端密钥。这用于授权访问。

GITHUB_SECRET_FILE​

  • 名称：WOODPECKER_GITHUB_SECRET_FILE
  • 默认值：无

从指定的文件路径读取 WOODPECKER_GITHUB_SECRET 的值。

GITHUB_MERGE_REF​

  • 名称：WOODPECKER_GITHUB_MERGE_REF
  • 默认值：true

启用拉取请求的合并引用支持。