アドマーケティング SSP開発チームのKA.Mです。無事引っ越しできました。
チーム内でGo言語が盛んになっており、同僚と共に日々精進しています。
vim-go と ale というPluginによるGo言語サポートが熱いですね。
✕
引用元: https://github.com/logos
引用元: https://atlassian.design/guidelines/marketing/resources/logo-files
最近、SSP開発チームでJIRA Softwareを使い始めました。実際に使いSSP開発チーム仕様にカスタマイズを加える事で利便性が向上した事例をご紹介致します。
まずはじめにJIRAの概要として、JIRAはアトラシアン株式会社様のサービスとなります。
チケット管理をカンバン形式で行う事で、直感的にチケット管理が可能となっている所が強みです。
JIRAの良さについてマネージメント面及び技術面の両面から後日テックブログで紹介できたらと考えています。
そのJIRAと前回環境を整備したGitHub環境を連携させ、JIRAのWorkflowステータスを自動で切り替える事が今回の目的です。
JIRAの「smart commit」
JIRAとGitHubの連携といえば「smart commit」です。
リモートブランチを作成、Pull Requestを作成、マージされたタイミングなどで、
JIRAのステータスを切り替える事が可能です。
課題
GitHubのレビュー機能を利用している場合に「smart commit」のステータス管理では実際の開発状況が伝わり辛く、
意思疎通に問題があり、手動でステータスを更新するといった運用が発生していました。
課題を解決する方針
GitHubのレビュー結果をフックし、ラベルを貼り付ける既存の運用を利用し、
ラベルが貼り付けられたイベントをトリガーにJIRAのWorkflowステータスを自動で更新させます。
JIRAのWorkflowステータスは自由に作成できるため、ここではSSP開発チームのステータスを例に挙げさせて頂きます。
| オペレーション | JiraのWorkflowステータス | GitHubのラベル | 技術的な話 |
|---|---|---|---|
| JIRAにチケット作成 | オープン | ||
| ローカルブランチ作成 | 変化なし | ||
| リモートブランチへpush | 作業中 | JIRAのsmart commit連携 | |
| PR作成 | 変化なし | ※PR作成時に「レビュー依頼」ラベルを設置した場合、ラベル貼り付けイベントが発火します。 | |
| 初回レビュー依頼(「レビュー依頼」貼り付け) | レビュー中 | レビュー依頼 | ラベル設置イベントをトリガーにJIRAに反映 |
| レビュー結果:Comment | 変化なし | 変化なし | |
| レビュー結果:Approve | リリース待ち | 確認済み | GitHubのWebhookによるラベル設置、ラベル設置イベントをトリガーにJIRAに反映 |
| レビュー結果:Request changes | 作業中 | 差し戻し | GitHubのWebhookによるラベル設置、ラベル設置イベントをトリガーにJIRAに反映 |
| 再レビュー依頼(「レビュー依頼」貼り付け) | レビュー中 | レビュー依頼 | ラベル設置イベントをトリガーにJIRAに反映 |
| マージ | 解決済み | 変化なし | JIRAのsmart commit連携 |
| リリース | 変化なし | 変化なし | |
| マネージャ最終確認 | 完了 | 変化なし |
なお、前回の記事から少しWebhookの挙動に変更を加えました。
- レビュー結果が「Comment」時はラベル操作は行わない
- レビュー結果が「Request changes」時は「差し戻し」のラベルを張る
- レビュー結果が「Approve」時は「確認済み」ラベルを張る(運用変わらず)
実オペレーションの確認
上記表を辿って頂けるとわかりますが、GitHub Flowに準拠する事で「解決済み」まで、
自動でステータスが切り替わります。あとはマネージャによる最終確認でチケットが「完了」となります。
では早速設定してみましょう。
実装コード例
GitHubのWebhook設定
PullRequestEventの”action:labeled”をトリガーに実現します。
前回同様に、GitHub側のWebhook設定を行います。
Webhookを適用したいリポジトリのページから Settings > Webhooks と遷移し、 Add webhook から新規にWebhookを追加します。
今回は Let me select individual events. を選択し、 Pull request のみにチェックを入れます。
リクエスト先の設定例
今回は貼り付けられたラベル「レビュー依頼」、「確認済み」、「差し戻し」に応じて適切にJIRAのステータスを更新します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
<?php /** * JiraAPI * * このステータスは例です。JIRAのステータスはカスタマイズ可能なため、各自でご確認下さい。 * * all status list (id - name) * 1 : オープン * 2 : 作業中 * 3 : レビュー中 * 4 : リリース待ち * 5 : 解決済み * 6 : 完了 * 7 : Reopen * * @see https://developer.atlassian.com/cloud/jira/platform/rest/ */ class JiraAPI { // Class variable private static $_username = '**** username ****'; private static $_password = '**** password ****'; private static $_domain = '**** JIRA Cloudのドメイン ****'; // @var $_workflowMatrix // Workflowステータスは更新可能なステータスが限定されているため、 // 目的のWorkflowステータスに遷移できるように導線を構築 // // 構築には `Get statuses` API を利用し、idと名前を確認し、 // 画面上から遷移経路を確認しマトリクスを作成します。 private static $_workflowMatrix = [ 3 => [ 1 => [2, 3], 2 => [3], 4 => [7, 2, 3], 7 => [2, 3], ], 4 => [ 1 => [2, 3, 4], 2 => [3, 4], 3 => [4], 7 => [2, 3, 4], ], 2 => [ 1 => [2], 3 => [7, 2], 4 => [7, 2], 7 => [2], ], ]; private static $_host = 'https://%s.atlassian.net'; private static $_authUrl = '/rest/auth/1/session'; private static $_issueUrl = '/rest/api/2/issue/%s'; private static $_issueGetTransitionsUrl = '/rest/api/2/issue/%s/transitions'; private static $_issueDoTransitionsUrl = '/rest/api/2/issue/%s/transitions'; private static $_statusesUrl = '/rest/api/2/status'; private $_auth; /** * __construct */ public function __construct() { $this->_auth = $this->_auth(); } /** * _getUrl * * @param string $url * @param array $args = [] * @return string */ private static function _getUrl(string $url, array $args = []): string { return sprintf(self::$_host, self::$_domain) . vsprintf($url, $args); } /** * _auth * * Cookie-basedの認証形式です。 * OAuth2.0, OAuth1.0a, Basicなどが他にもあります。 * * @return array * @throws RuntimeException * @see https://developer.atlassian.com/cloud/jira/platform/rest/#api-auth-1-session-post */ private function _auth(): array { $ch = curl_init(); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HEADER => false, CURLOPT_HTTPHEADER => [ 'Accept: application/json', 'Content-type: application/json', ], CURLOPT_URL => self::_getUrl(self::$_authUrl), CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode([ 'username' => self::$_username, 'password' => self::$_password, ]), ]); $body = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); if ($info['http_code'] !== 200) { throw new RuntimeException($body, $info['http_code']); } return json_decode($body, true); } /** * getIssue * * チケットキー情報からチケットID、現在のWorkflowステータスを取得 * * @param string $key * @return array * @throws RuntimeException * @see https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-get */ public function getIssue(string $key): array { $ch = curl_init(); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HEADER => false, CURLOPT_HTTPHEADER => [ "Cookie: {$this->_auth['session']['name']}={$this->_auth['session']['value']}", 'Accept: application/json', ], CURLOPT_URL => self::_getUrl(self::$_issueUrl, [$key]), ]); $body = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); if ($info['http_code'] !== 200) { throw new RuntimeException($body, $info['http_code']); } return json_decode($body, true); } /** * getTransitions * * 更新予定のWorkflowステータスのTransitionIDを取得 * * @param int $issueId * @return array * @throws RuntimeException * @see https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-get */ public function getTransitions(int $issueId): array { $ch = curl_init(); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HEADER => false, CURLOPT_HTTPHEADER => [ "Cookie: {$this->_auth['session']['name']}={$this->_auth['session']['value']}", 'Accept: application/json', ], CURLOPT_URL => self::_getUrl(self::$_issueGetTransitionsUrl, [$issueId]), ]); $body = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); if ($info['http_code'] !== 200) { throw new RuntimeException($body, $info['http_code']); } return json_decode($body, true); } /** * updateTransitions * * Workflowステータス更新処理 * * @param int $issueId * @param int $transitionId * @throws RuntimeException * @see https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-issue-issueIdOrKey-transitions-post */ public function updateTransitions(int $issueId, int $transitionId) { $ch = curl_init(); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HEADER => false, CURLOPT_HTTPHEADER => [ "Cookie: {$this->_auth['session']['name']}={$this->_auth['session']['value']}", 'Accept: application/json', 'Content-type: application/json', ], CURLOPT_URL => self::_getUrl(self::$_issueDoTransitionsUrl, [$issueId]), CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode([ 'transition' => [ 'id' => $transitionId, ] ]), ]); $body = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); if ($info['http_code'] !== 200 && $info['http_code'] !== 204) { throw new RuntimeException($body, $info['http_code']); } return json_decode($body, true); } /** * getStatuses * * Workflowステータス一覧を取得 * 実運用上、本関数は呼ばれません。 * * @return array * @throws RuntimeException * @see https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-status-get */ public function getStatuses(): array { $ch = curl_init(); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HEADER => false, CURLOPT_HTTPHEADER => [ "Cookie: {$this->_auth['session']['name']}={$this->_auth['session']['value']}", 'Accept: application/json', ], CURLOPT_URL => self::_getUrl(self::$_statusesUrl), ]); $body = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); if ($info['http_code'] !== 200) { throw new RuntimeException($body, $info['http_code']); } return json_decode($body, true); } /** * autoTransitions * * @param int $issueId * @param int $fromStatus * @param int $toStatus * @return array * @throws RuntimeException */ public function autoTransitions(int $issueId, int $fromStatus, int $toStatus): array { $ret = []; if (isset(self::$_workflowMatrix[$toStatus]) && isset(self::$_workflowMatrix[$toStatus][$fromStatus])) { foreach (self::$_workflowMatrix[$toStatus][$fromStatus] as $status) { $transitions = $this->getTransitions($issueId); if (0 < count($transitions)) { foreach ($transitions['transitions'] as $transition) { if (!empty($transition['to']['id']) && $transition['to']['id'] == $status) { $this->updateTransitions($issueId, $transition['id']); break; } } } } } return $ret; } } $secret = '**** Webhookに登録したSecret情報 ****'; $payloadPrefix = 'payload='; $actionTypeLabeled = 'labeled'; // @var $relationGitHubJira // GitHub の Label に応じた Jira のWorkflowステータスのステータスIDです $relationGitHubJira = [ 'レビュー依頼' => 3, '確認済み' => 4, '差し戻し' => 2, ]; $header = getallheaders(); $postJson = file_get_contents('php://input'); $hmac = hash_hmac('sha1', $postJson, $secret); $payloadLen = strlen($payloadPrefix); if (isset($header['X-Hub-Signature']) && $header['X-Hub-Signature'] === "sha1={$hmac}") { if (substr($postJson, 0, $payloadLen) === $payloadPrefix) { $postArray = json_decode(urldecode(substr($postJson, $payloadLen)), true); } else { $postArray = json_decode($postJson, true); } try { switch ($postArray['action']) { case $actionTypeLabeled: if (isset($relationGitHubJira[$postArray['label']['name']])) { //smart commit の仕様を踏襲し、ブランチ名の先頭にチケットキー情報を設定しています preg_match('/Axxx-[d]+/u', $postArray['pull_request']['head']['ref'], $matches); if (1 === count($matches)) { $jira = new JiraAPI(); $issue = $jira->getIssue($matches[0]); $jira->autoTransitions($issue['id'], $issue['fields']['status']['id'], $relationGitHubJira[$postArray['label']['name']]); } } break; } } catch (RuntimeException $re) { } catch (Exception $e) { } } |
まとめ
日々便利なサービスがリリースされ開発効率が向上していく中、複数のサービスを使いこなすには体力がいります。
便利なサービスを使っているにも関わらずサービスに振り回され消耗して終わる事もあると思います。
そうならないためにも、サービスを使いこなす、もしくは担当者の負荷がかからないように逃げる術を用意する事で現場のモチベーションが高まります。
