プロジェクトのGitHub Readme.mdでJenkinsビルドステータスを表示する方法はありますか？

私はJenkinsを使用して継続的インテグレーションビルドを実行しています。各コミットの後、最終的にドキュメントとリリースバンドルを作成する前に、すべてがコンパイルされ、ユニットテストと統合テストが実行されることが保証されます。

ビルドを壊す何かを誤ってコミットするリスクはまだあります。GitHubプロジェクトページにアクセスしているユーザーが、現在のマスターがその状態であることを知るのは良いことです。

では、Jenkinsを設定してGitHubビルドステータスを設定する方法を説明します。これは、GitHubプラグインがすべてのプッシュでビルドを実行するように構成されたJenkinsをすでに取得していることを前提としています。

1. GitHubに移動してログインし、[設定]、[ 個人用アクセストークン ]、[ 新しいトークンの生成 ]の順にクリックします。

   

2. repo：statusを確認します（これが必要かどうかはわかりませんが、実際に実行しましたが、うまくいきました）。

   

3. トークンを生成してコピーします。

4. 使用するGitHubユーザーがリポジトリコラボレーター（プライベートリポジトリの場合）、または構築するリポジトリへのプッシュおよびプルアクセス（組織リポジトリの場合）を持つチームのメンバーであることを確認します。

5. Jenkinsサーバーに移動し、ログインします。

6. Jenkinsの管理 → システムの構成

7. 下ではGitHubのウェブフック選びましょジェンキンスは、フックのURLを自動管理し、その後、あなたのGitHub指定したユーザ名とトークンのOAuthを使用すると、ステップ3で得ました。

   

8. [ 資格情報のテスト ]ボタンで機能することを確認します。 設定を保存します。

9. Jenkinsジョブを見つけて、GitHubコミットでビルドステータスの設定をビルド後のステップに追加します

   

それでおしまい。次に、テストビルドを実行し、GitHubリポジトリに移動して、機能するかどうかを確認します。メインリポジトリページのブランチをクリックして、ビルドステータスを確認します。

緑のチェックマークが表示されます。

その間、JenkinsとGitHubのUIが少し変更され、Jenkinsを正しく設定する方法を理解するのにしばらく時間がかかりました。ここでの説明は、Jenkinsバージョン2.121.1に基づいています。

また、JenkinsジョブがWebhookまたはポーリングによってトリガーされるように構成済みであると想定しています。これらは私がそれを機能させるために取ったステップです：

1. Githubの構成：OAuthスコープを使用した個人用アクセストークンの作成 repo:status
2. Jenkinsを構成Configure Systemし、GitHubサーバーとしてOAuthシークレットを追加しますSecret Text -OAuthシークレットをそこに配置するための認証方法として使用します。
3. Jenkinsジョブを設定します：ビルド後のアクションSet GitHub commit statusとして追加。ステータス結果をに設定します。One of the default messages and statuses
4. GitHubで結果を確認します。GitHubコミットでビルドステータスとビルド実行時間を取得しているかどうかを確認します。

Githubを構成する

Jenkinsを構成する

Jenkinsジョブを構成する

結果

コミットとブランチのステータスが表示されます。

私がしたことは非常に簡単です：

1. Hudson Post Taskプラグインをインストールする
2. ここでパーソナルアクセストークンを作成します。https：//github.com/settings/tokens

3. 常に成功するPost Taskプラグインを追加する

   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!\"
   }"
   

4. 「ビルドを失敗としてマーク」した場合に失敗するPost Task Pluginを追加します

   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!\"
   }"
   

5. テストの開始時に保留中への呼び出しを追加することもできます

   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!\"
   }"
   

このプラグインは動作するはずです：https : //wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin

このようなバッジをREADME.mdファイルに埋め込むことができるはずです。

コミットステータスAPIあなたは「を参照してくださいすることができますレポステータスのAPIを」。

そして2013年4月26日以降、GitHubリポジトリブランチページでビルドステータスを確認できるようになりました。

つまり、Jenkinsだけではなく、GitHubプロジェクトページにアクセスして、これらのステータスを確認することもできます。

2013年4月30日から、コミットステータスのAPIエンドポイントが拡張され、ブランチ名とタグ名、およびコミットSHAが許可されるようになりました。

README.mdに投稿できるバッジのURLを提供するこのプラグインもあります。

https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin

にGithubプラグインがインストールされてJenkinsいる場合は、次のPost build actionsように実行できます。

README.mdに以下の行を追加し、jenkinsプロジェクトに従って両方のURLを変更します。

[![Build Status](https://jenkins../..project/lastBuild/buildStatus)](https://jenkins../..project/lastBuild/)

JenkinsとGitHubの保護されたブランチのセットアップに関して。私はJenkins 2.6を使用していますが、これを機能させるために実行した手順は次のとおりです。

リポジトリのGitHubウェブページ：

1. [設定]> [ブランチ]に移動します。
2. [ブランチの保護]で、[溺死するブランチの選択]メニューをクリックし、保護されたブランチとして設定するブランチを選択します。
3. 必要に応じてオプションを有効にします。

Jenkinsサーバー：（GitおよびGitHubプラグインがインストールされていることを確認してください）

1. [Jenkinsの管理]> [システムの構成]に移動します。
2. GitHubで、API URLをhttps://api.github.comに設定します。これはデフォルト値ですが。
3. 資格情報用に生成されたトークンを選択します。トークンをまだ生成していない場合は、[詳細...]をクリックしてから、[追加のアクション]でログインとパスワードをトークンに変換し、それを資格情報として使用できます。

また、Jenkinsが使用しているGitHubアカウントがリポジトリのコラボレーターであることを確認してください。書き込み許可レベルを設定しました。

お役に立てれば。

私はアレックスの指示に従いましたが、うまくいきました。

ただし、GitHub Enterpriseでは、サーバーをJenkinsに追加するときにAPI URLを変更する必要があります。

たとえば、会社がcreditcard.comの場合、URLは次のようになります。

https://github.creditcard.com/api/v3/

Jentlyは、あなたの更新のGithubのステータスをコミット（上記@voncで説明したように）、残念ながら彼らが実装する必要があり、まだレポステータスAPIを

編集：

このアプローチはもう使用していません。他の回答のいずれかを使用してください。

更新：私たちの特定のケースで私が最終的に何をしたか：（ 上記の回答は素晴らしかった-ありがとう！）

ビルドサーバーがインターネット上にないため、ビルドステータスをgithubのgh-pagesブランチに公開するスクリプトがあります。

• ビルドスタンプの開始が失敗する
• ビルド終了スタンプの成功
• プロジェクトはメインプロジェクトの後に実行され、結果を公開します->ビルドステータス、APIドキュメント、テストレポート、およびテストカバレッジ。

GitHubはイメージをキャッシュするため、ビルドステータスイメージの短いキャッシュタイムアウトを指示する.htaccessファイルを作成しました。

これをビルドステータスイメージのあるディレクトリに配置します。

ExpiresByType image/png "access plus 2 minutes"

これがビルドスクリプトです。gh-pagesに公開するターゲットは'--publish.site.dry.run'です

構成が400行未満の場合、次のようになります。

• コンパイルチェック
• 単体テストと統合テスト
• テストレポート
• コードカバレッジレポート
• APIドキュメント
• Githubへの公開

。。このスクリプトはジェンキンスの内外で実行できるため、次のようになります。

• 開発者はコミット前にこのスクリプトを実行できるため、ビルドが壊れて他のユーザーに影響が及ぶ可能性が低くなります。
• 障害はローカルで簡単に再現できます。

結果：

プロジェクトのメインページには、最新のAPIドキュメント、テスト結果、およびテストカバレッジと共に、各ビルド後に更新されるビルドステータスがあります。