AWS CodeCommitでプルリク機能を使ってみよう！

はじめに

AWS CodeCommitを使っていますか？
CodeCommitは、AWSから提供されている完全マネージド型のバージョン管理サービス(Git)になります。

CodeCommitのサービスが一般公開となったのが2015年7月、東京リージョンで使えるようになったのが2017年5月末でしたが、ついに2017年11月末に待望のプルリクエスト機能がアップデートで追加されました。

プルリクエスト機能の追加から約半年ほど経ちましたが、CodeCommitのプルリクエスト機能に言及している記事がネット上にあまり見かけませんので、簡単にプルリクエスト機能の使い方を解説したいと思います。

AWS CodeCommitとは？

まずは、おさらい。

AWS CodeCommitとは、完全マネージド型のGitサービスになります。

Gitの特徴や分散型バージョン管理システムなどについての説明は、この記事では行いませんので、こちらの記事などを読んでみてください。
サルでもわかるGit入門 〜バージョン管理を使いこなそう〜

完全マネージド型サービスとなりますので、サーバの管理やソフトウェアの管理、リポジトリを保管するストレージの管理など一切考える必要はありません。（サーバーレスですね！）

AWS CodeCommitの特徴として、IAMでユーザ管理出来たり、CodeStarやCodeBuild・Beanstalkのソース場所として使用できたり、リポジトリイベントに応答するLambdaファンクションを作成出来たりと、他のAWSのサービスとの親和性が高いことが挙げられますので、AWSを使ってDevOpsに取り組むのであれば是非CodeCommitを使ってみてください。

プルリクエスト機能の使い方

前提

• 今回のシナリオは、「ログイン画面の文言修正」が発生したシナリオとします。

• Gitの運用については「git-flow」で運用しているものとします。

  • 以下のブランチが存在している前提です。

    1. masterブランチ・・・本番リリース状態ブランチ
    2. developブランチ・・・開発ブランチ
    3. feature/login_changeブランチ・・・今回修正を行うブランチ

  • 「git-flow」の説明は以下を参照してください。

    A successful Git branching model ｜ nvie.com

    AWSチーム社内勉強会「git-flow」レポート ｜ Developer.IO

• CodeCommitのセットアップ方法やリポジトリの作成方法、使い方については、当記事では説明しませんので、以下の記事などを参照してください。
  CodeCommit入門 – Code三兄弟を知る ｜ Developers.IO
  ​

【開発者】機能修正用のfeatureブランチを作成し、ソースを修正する

1. 機能の修正に取り掛かるために、developブランチからfeatureブランチを作成する。

2. ブランチを作成したfeatureブランチに切り替える。

3. 対象のソースコードの修正を行う。

4. 修正したソースコードをステージングする。

5. 変更内容をコミットする。

6. 変更内容をリモートにプッシュする。

【開発者】CodeCommitでプルリクエストを作成する

• １. CodeCommitのサービスを選択し、対象のリポジトリを開き、対象のブランチの「プルリクエストの作成」を選択する。

• ２. 今回のプルリクエストの内容を「タイトル」「説明」に記載する。

• プルリクメッセージの記載内容は以下の記事を参考にしてみてください。
  GitHub「完璧なプルリクの書き方を教えるぜ」| qiita

• ３. 通知エリアの差分内容を確認し、問題が無ければ、「保存」をクリックする。

• ４. プルリクエストが作成されました。

【他の開発者】プルリクエストの確認を行う

1. CodeCommitのサービスを選択し、対象のリポジトリを開き、「オープン」状態のプルリクエストを選択する。

1. 「変更」タブを開いて、変更内容のコードレビューを行い、コメントを記載し「保存」する。

コメントは分かりやすく、サンプルなどを記載してあげると良いと思います。

【開発者】コメントを確認し、指摘事項の修正を行う

1. CodeCommitのプルリクエストのコメントを確認し、指摘事項への対応を行う。
2. 修正したソースコードをコミット・プッシュする。
3. CodeCommitのプルリクエストを確認すると、コミットが更新されていることが確認できます。

1. 他開発者からのコメントに返信し、マージの依頼を行う。

【他開発者】指摘事項の修正を確認しマージする

1. CodeCommitのプルリクエストの内容を確認し、問題が無ければ「マージ」をクリックする。

1. featureブランチは対応完了後に自動的に削除するためチェックを付与して「マージ」をクリックする。

1. 変更分がマージされ、プルリクエストがクローズされます。

1. オープン状態のプルリクエストがなくなったことを確認します。

• 以上がプルリクエスト運用の説明となります。

最後に

リポジトリに対して通知メールの設定をしている場合は、プルリクエストの作成時・更新時にSNSトピックに対して通知が行われますので、slackなどと連携させて、開発者で運用を決めておくと使い易いと思います。

最後になって気付きましたが、マージ先がmasterブランチになっていました。。。
masterブランチは本番用ブランチですので、マージ先は正しくdevelopブランチに行ってください m(_ _)m