Jenkins 与 GitHub 集成插件使用技术文档

本文档旨在帮助用户详细理解和使用 Jenkins 与 GitHub 集成插件，以下是关于插件的安装、使用说明、API 使用文档以及安装方式的详细介绍。

1. 安装指南

在开始之前，请确保您的 Jenkins 系统已正确安装并运行。以下是插件的安装步骤：

1. 打开 Jenkins 主页面。
2. 进入 "管理Jenkins" 菜单，选择 "管理插件"。
3. 在 "可用" 选项卡中搜索 "GitHub Plugin"。
4. 选中插件并点击 "安装"。

安装完成后，Jenkins 会自动重启插件。

2. 项目的使用说明

超链接功能

该插件可以将 Jenkins 项目与 GitHub 项目进行关联，创建从 Jenkins "变更" 页面到 GitHub 提交和问题页面的链接。在创建任务时，指定任务连接到 Git。在 "GitHub 项目" 中输入 [e-mail]:*Person*/*Project*.git。在 "源代码管理" 中选择 Git，并输入 [e-mail]:*Person*/*Project*.git。

GitHub hook 触发器

此功能允许在 GitHub 仓库的 post-receive hooks 触发后启动构建。此触发器仅针对每个传入事件触发 git 插件内部轮询算法。

手动模式

在此模式下，需要手动为每个项目添加 webhook URL。点击 "帮助" 图标（在 "管理 Jenkins" > "系统配置" > "GitHub" 下）查看 Jenkins 接收 post-commit POSTs 的 URL。通常 URL 形式为 $JENKINS_BASE_URL/github-webhook/。

自动模式

在此模式下，Jenkins 会根据项目配置自动添加/移除 webhook URLs。您需要指定 GitHub OAuth 令牌以便 Jenkins 可以登录您的账户进行操作。

• Step 1：进入全局配置，添加 GitHub 服务器配置。
• Step 2.1：在 GitHub 中创建个人访问令牌。
• Step 2.2：选择之前创建的 "Secret Text" 凭据，其中包含 GitHub OAuth 令牌。
• Step 3：在需要自动触发的每个项目的配置中，勾选 "GitHub hook trigger for GITScm polling"。

3. 项目API使用文档

该插件提供了一些 API 用于与 GitHub 交互，以下是几个示例：

设置提交状态

以下代码将设置自定义仓库的提交状态，并配置上下文和信息：

void setBuildStatus(String message, String state) {
  step([
      $class: "GitHubCommitStatusSetter",
      reposSource: [$class: "ManuallyEnteredRepositorySource", url: "https://github.com/my-org/my-repo"],
      contextSource: [$class: "ManuallyEnteredCommitContextSource", context: "ci/jenkins/build-status"],
      errorHandlers: [[$class: "ChangingBuildStatusErrorHandler", result: "UNSTABLE"]],
      statusResultSource: [ $class: "ConditionalStatusResultSource", results: [[$class: "AnyBuildResult", message: message, state: state]] ]
  ]);
}

setBuildStatus("Build complete", "SUCCESS");

4. 项目安装方式

项目的安装方式已在 "安装指南" 中详细描述。确保按照步骤操作，正确配置 GitHub 服务器和 OAuth 令牌，以便插件可以正常运行。

通过以上内容，用户应该能够顺利安装并使用 Jenkins 与 GitHub 集成插件，实现 Jenkins 和 GitHub 之间的自动化工作流。