このAPIでは、ステータスAPIを使って、利用できる設定を示します。 このシナリオでは、以下を行います。
プルリクエストが開かれたときにCIスイートを実行します (CIステータスを保留中に設定します)。 CIが終了したら、それに応じてプルリクエストのステータスを設定します。
- このCIシステムとホストサーバーは、想像上のものです。
- Travis でも、Jenkins でも、何でも構いません。
このガイドのポイントは、通信を管理するサーバーを設定し、構成することにあります。 まだ行っていない場合は ngrok をダウンロードし、その使い方をご確認ください。 これは、ローカル アプリケーションをインターネットに公開するために非常に便利なツールであることがわかりました。
詳しくは、「GitHub CLI を使った Webhook の受信」を参照してください。
サーバーを書く
ローカル接続が機能していることを証明するための、簡単なSinatraアプリケーションを書きます。
まずは以下のソースから始めましょう。
(Sinatra のしくみに詳しくない場合は、Sinatra ガイドを読むことをお勧めします。) このサーバーを起動してください。
require 'sinatra'
require 'json'
post '/event_handler' do
payload = JSON.parse(params[:payload])
"Well, it worked!"
end
既定では、Sinatra はポート 4567 で起動するため、これのリッスンも開始するよう ngrok を構成します。
このサーバーが機能するには、webhookでリポジトリを設定する必要があります。 プルリクエストが作成やマージされるたびに、webhookが起動するよう設定すべきです。
なんでも好きにして構わないようなリポジトリを作成しましょう。
@octocat の Spoon/Knife リポジトリなどはどうでしょうか。
その後、お使いのリポジトリ内に新しい Webhook を作成し、ngrok で提供された URL を指定し、コンテンツ タイプとして application/x-www-form-urlencoded を選びます。 新しいngrok URL
[Webhook の更新] をクリックします。
すばらしい。 [個々のイベントの選択] をクリックし、以下を選びます。 状態 Pull Request
- これらは、関係するアクションが発生するたびに GitHub Enterprise Cloud によってこのサーバーに送信されるイベントです。
- ここで pull request のシナリオ だけを処理するようサーバーを更新しましょう。
何が起こっているのでしょうか。 GitHub Enterprise Cloud によって送信されるすべてのイベントには、X-GitHub-Event HTTP ヘッダーが添付されています。
post '/event_handler' do
@payload = JSON.parse(params[:payload])
case request.env['HTTP_X_GITHUB_EVENT']
when "pull_request"
if @payload["action"] == "opened"
process_pull_request(@payload["pull_request"])
end
end
end
helpers do
def process_pull_request(pull_request)
puts "It's #{pull_request['title']}"
end
end
ここではPRイベントのみに注目しましょう。 そこから、情報のペイロードを取得し、タイトルのフィールドを返します。 理想的なシナリオにおいては、pull request が開かれたときだけではなく、更新されるたびにサーバーが関与します。 そうすると、すべての新しいプッシュがCIテストに合格するようになります。 しかしこのデモでは、開かれたときについてのみ気にすることにしましょう。 この概念実証を試すため、テスト リポジトリのブランチで何か変更を行い、pull request を開きます。 そうすると、サーバーはそれに応じてレスポンスを返すはずです。
ステータスを扱う サーバーの環境を整えたところで、最初の要件、つまり CI 状態の設定 (と更新) を始める準備が整いました。
いつでもサーバーを更新するときに、 [再配信] をクリックして同じペイロードを送信できることに留意してください。
変更を行うたびに新しい pull request を作成する必要はありません。 GitHub API とやり取りしているので、そのやり取りを管理するために Octokit.rb を使います。 そのクライアントを personal access token で構成します。
その後、CI で処理していることを明確にするため、GitHub Enterprise Cloud の pull request を更新するだけでよいのです。 ここでは3つの基本的なことを行っています。
# !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!!
# Instead, set and test environment variables, like below
ACCESS_TOKEN = ENV['MY_PERSONAL_TOKEN']
before do
@client ||= Octokit::Client.new(:access_token => ACCESS_TOKEN)
end
リポジトリのフルネームを検索する
def process_pull_request(pull_request)
puts "Processing pull request..."
@client.create_status(pull_request['base']['repo']['full_name'], pull_request['head']['sha'], 'pending')
end
プルリクエストの最後のSHAを検索する
- ステータスを「保留中」に設定する
- これで完了です。
- これで、テスト スイートを実行するために必要なあらゆるプロセスを実行できます。
コードを Jenkins に渡すことも、API 経由で Travis のような別の Web サービスを呼び出すこともできます。 その後は、状態をもう一度更新するようにしてください。 この例では、単に "success" に設定します。 まとめ GitHub では長年、CI を管理するためにあるバージョンの Janky を使ってきました。
def process_pull_request(pull_request)
@client.create_status(pull_request['base']['repo']['full_name'], pull_request['head']['sha'], 'pending')
sleep 2 # do busy work...
@client.create_status(pull_request['base']['repo']['full_name'], pull_request['head']['sha'], 'success')
puts "Pull request processed!"
end
その基本的なフローは、上記で構築してきたサーバーと本質的にまったく同じです。
GitHubでは、以下を実行しています。 プルリクエストが作成または更新されたときにJenkinsに送信する (Janky経由) CIのステータスについてのレスポンスを待つ
- コードが緑色なら、プルリクエストにマージする
- これら全ての通信は、チャットルームに集約されます。
- この例を使うために、独自の CI 設定をビルドする必要はありません。
いつでも GitHub 統合に頼ることができます。 You don't need to build your own CI setup to use this example.
You can always rely on