跳到主要内容

GitHub

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

WOODPECKER_GITHUB=true
WOODPECKER_GITHUB_CLIENT=YOUR_GITHUB_CLIENT_ID
WOODPECKER_GITHUB_SECRET=YOUR_GITHUB_CLIENT_SECRET

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

注意

不要使用 "GitHub App" 替代 Oauth2 应用程序,因为前者目前与 Woodpecker 无法正确配合工作(因为用户访问令牌不会自动刷新)

应用设置

客户端密钥创建

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

配置

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


GITHUB

  • 名称: WOODPECKER_GITHUB
  • 默认值: false

启用 GitHub 驱动程序。


GITHUB_URL

  • Name: WOODPECKER_GITHUB_URL
  • Default: https://github.com

Configures the GitHub server address.


GITHUB_CLIENT

  • Name: WOODPECKER_GITHUB_CLIENT
  • Default: none

Configures the GitHub OAuth client id to authorize access.


GITHUB_CLIENT_FILE

  • Name: WOODPECKER_GITHUB_CLIENT_FILE
  • Default: none

Read the value for WOODPECKER_GITHUB_CLIENT from the specified filepath.


GITHUB_SECRET

  • Name: WOODPECKER_GITHUB_SECRET
  • Default: none

Configures the GitHub OAuth client secret. This is used to authorize access.


GITHUB_SECRET_FILE

  • Name: WOODPECKER_GITHUB_SECRET_FILE
  • Default: none

Read the value for WOODPECKER_GITHUB_SECRET from the specified filepath.


GITHUB_MERGE_REF

  • Name: WOODPECKER_GITHUB_MERGE_REF
  • Default: true

GITHUB_SKIP_VERIFY

  • Name: WOODPECKER_GITHUB_SKIP_VERIFY
  • Default: false

Configure if SSL verification should be skipped.


GITHUB_PUBLIC_ONLY

  • Name: WOODPECKER_GITHUB_PUBLIC_ONLY
  • Default: false

Configures the GitHub OAuth client to only obtain a token that can manage public repositories.