有没有办法在我项目的 GitHub Readme.md 上显示 Jenkins 构建状态？
我使用 Jenkins 来运行持续集成构建。每次提交后，它确保一切都编译，以及执行单元和集成测试，然后最终生成文档和发布包。
仍然存在无意中提交破坏构建的风险。访问 GitHub 项目页面的用户最好知道当前 master 处于该状态。
【问题讨论】：
好的，以下是设置 Jenkins 以设置 GitHub 构建状态的方法。这假设您已经拥有 Jenkins，并配置了 GitHub 插件以在每次推送时进行构建。
前往 GitHub，登录，前往设置、开发者设置、个人访问令牌并点击生成新令牌。
检查 repo:status（我不确定这是否必要，但我做到了，而且对我有用）。
生成令牌，复制它。
确保您要使用的 GitHub 用户是存储库协作者（对于私有存储库）或者是对您要构建的存储库具有推送和拉取访问权限（对于组织存储库）的团队成员。
转到您的 Jenkins 服务器，登录。
管理 Jenkins → 配置系统
在 GitHub Web Hook 下选择 让 Jenkins 自动管理挂钩 URL，然后指定您的 GitHub 用户名 和 OAuth 令牌您已进入第 3 步。
验证它是否可以与 Test Credential 按钮一起使用。 保存设置。
找到 Jenkins 作业并将 Set build status on GitHub commit 添加到构建后步骤
就是这样。现在进行测试构建并转到 GitHub 存储库以查看它是否有效。单击主存储库页面中的 Branches 以查看构建状态。
您应该会看到绿色复选标记：
【讨论】：
与此同时，Jenkins 和 GitHub 的 UI 发生了一些变化，我花了一段时间才弄清楚如何正确配置 Jenkins。这里的解释是基于Jenkins 2.121.1版本的。
我还假设您已经配置了由 webhook 或轮询触发的 Jenkins 作业。 这些是我为使其工作而采取的步骤：
repo:status
Configure System 并将 OAuth Secret 添加为 GitHub 服务器 - 使用 Secret Text 作为身份验证方法将 OAuth Secret 放入其中。Set GitHub commit status 作为构建后操作。将状态结果设置为One of the default messages and statuses。您现在将看到提交和分支的状态：
【讨论】：
Manage Hooks 框在上图中高亮显示但未勾选，是否意味着保存时应取消勾选？
我做的很简单：
添加一个总是成功的发布任务插件
curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
\"state\": \"success\",
\"target_url\": \"${BUILD_URL}\",
\"description\": \"The build has succeeded!\"
}"
添加一个发布任务插件，如果“将构建标记为失败”，则会失败
curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
\"state\": \"failure\",
\"target_url\": \"${BUILD_URL}\",
\"description\": \"The build has failed!\"
}"
您还可以在测试开始时添加对挂起的调用
curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
\"state\": \"pending\",
\"target_url\": \"${BUILD_URL}\",
\"description\": \"The build is pending!\"
}"
【讨论】：
sh 调用它，甚至可以通过 withCredentials 使用 Jenkins 凭据存储
这个插件应该可以工作：https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin
您应该能够将这样的徽章嵌入到您的README.md 文件中：
【讨论】：
Commit Status API 允许您查看“Repo Statuses API”。
自 2013 年 4 月 26 日起，您现在可以在您的 GitHub repo branch page 上看到 build status：
这意味着这是另一种方式，通过访问 GitHub 项目页面，可以查看这些状态，而不是只有 Jenkins。
从 2013 年 4 月 30 日开始，API endpoint for commit statuses 已扩展为允许分支和标签名称，以及提交 SHA。
【讨论】：
curl (developer.github.com/v3/repos/statuses/…)
还有这个插件会给你一个徽章网址，你可以在你的 README.md 中发布它，看起来像这样
https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin
【讨论】：
如果您的Jenkins 上安装了Github 插件，您可以在Post build actions 中这样做：
【讨论】：
在您的 README.md 中添加以下行，并根据您的 jenkins 项目更改这两个 URL。
[](https://jenkins../..project/lastBuild/)
【讨论】：
关于设置 Jenkins 和 GitHub 的受保护分支。我正在使用 Jenkins 2.6，这些是我为使其工作而采取的步骤：
在您的存储库的 GitHub 网页上：
在 Jenkins 服务器上： （确保您已安装 Git 和 GitHub 插件）
此外，请确保您的 Jenkins 使用的 GitHub 帐户是存储库的合作者。我已将其设置为写入权限级别。
希望这会有所帮助。
【讨论】：
我按照Alex 的指示进行操作，效果很好。
但是，对于 GitHub Enterprise，您需要在将服务器添加到 Jenkins 时修改 API URL。
例如，如果您的公司是 creditcard.com，那么您的网址将是
【讨论】：
Jently 更新你的Github commit status（如上面@vonc 所述），不幸的是他们还没有实现Repo Status API
【讨论】：
编辑：
我不再使用这种方法，请使用其他答案之一。
更新：对于我们的具体情况，我最终做了什么： （以上答案很棒 - 谢谢！）
因为我们的构建服务器不在互联网上，所以我们有一个脚本可以将构建状态发布到 github 的 gh-pages 分支。
GitHub 缓存图像，因此我们创建了 .htaccess 文件，该文件指示构建状态图像的短暂缓存超时。
把它放在带有构建状态图像的目录中：
ExpiresByType image/png "access plus 2 minutes"
Here's 构建脚本。发布到 gh-pages 的目标是 '--publish.site.dry.run'
只有不到 400 行的配置，我们有：
。 .并且此脚本可以在 Jenkins 内部或外部运行，因此：
结果：
Project main page 具有每次构建后更新的构建状态，以及最新的 API 文档、测试结果和测试覆盖率。
【讨论】：
对于 管道项目，您可以像这样使用 post 部分：
void setBuildStatus(String message, String state) {
step([
$class: "GitHubCommitStatusSetter",
reposSource: [$class: "ManuallyEnteredRepositorySource", url: "https://github.com/my-user/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]] ]
]);
}
pipeline {
agent any
triggers {
githubPush()
}
stages {
stage('Hello') {
steps {
echo 'Hello World'
}
}
}
post {
success {
setBuildStatus("Build succeeded", "SUCCESS");
}
failure {
setBuildStatus("Build failed", "FAILURE");
}
}
}
只需更改“https://github.com/my-user/my-repo”即可满足您的 github 存储库。
【讨论】：
添加到 this answer 和 this one 他们已经回答了问题，但没有给我们关于问题的正确直觉
所以，这是我的直觉：
GH settings -> Developer settings -> Personal access tokens 的令牌，然后用于公共 GH repo检查 repo:status，对于私人 repo，检查 整个 repo 部分
资源：
【讨论】：