githubを使っての開発(1)　－実践github-flow－

今は開発でgithubを利用しています。
開発をおこなう上で、githubをどのように扱えば良いのか。
思いの外、github-flowが良かったのでメモ書き程度に色々と書いておきます。

github-flowについて

GitHub Flowとは何か？

• masterブランチのものは何であれデプロイ可能である
• 新しい何かに取り組む際は、説明的な名前のブランチをmasterから作成する（例: new-oauth2-scopes）
• 作成したブランチにローカルでコミットし、サーバー上の同じ名前のブランチにも定期的に作業内容をpushする
• フィードバックや助言が欲しい時、ブランチをマージしてもよいと思ったときは、 プルリクエスト を作成する
• 他の誰かがレビューをして機能にOKを出してくれたら、あなたはコードをmasterへマージすることができる
• マージをしてmasterへpushしたら、直ちにデプロイをする

GitHub Flow (Japanese translation)

　作業の流れ

これだけ書かれても、git/githubに慣れてない人からすると「？」になります。
私も最初はそうでした。。

そこで、作業の流れを書いておきます。

　新ブランチ作成

1) まず、ソースがないと始まらないのでcloneをします。

 git clone https://github.com/xxxxxx/yyyyy.git

2) 機能の名前をつけたブランチを作成

 git checkout -b branch-name origin/master

これで、作業をする箇所が出来ました。
以下のコマンでで、ちゃんとブランチが正しいのになっているか確認します。

 git branch

※自分の現在のブランチが何か分からないと危険なので、gitのブランチ名が表示されるように設定したほうが良いです。
Macなら参考

　作業開始＆ローカルリポジトリにコミット

作成したブランチでソースを書きます。
そして、定期的にローカルにコミットします。

 git add 追加したファイル名
 git commit -m "○○機能の追加"

　githubにコミット

ブランチで作成しているので、masterが汚れることはありません。
そこで、定期的にリgithubにpushします。

 git push origin branch-name

　コードが完成したらPullRequest

githubにはPullRequestという機能があります。
コードが完成したなと思ったら、自身のブランチからPull Requestを投げます。

この操作は、githubから行えます。
自身のブランチからPull Requestをクリックしてメッセージを入れるだけ。

　第三者がレビュー

Pull Requestが投げられたら、コードに対してレビューをします。
githubでは、PullRequestされたコードに対してコメントが書けます。

　レビュー内容を元に修正しソースコードをpush

レビュー内容を元に修正が必要な箇所を修正し、ソースコードを再度pushします。

 git push origin branch-name

　レビュー＆修正が終わったら担当者がマージ

masterブランチに入れても問題ない状態になったら、担当者がマージします。
この詳細については別エントリーで書いておきます。

　利点

常に動くものがmasterブランチにあり、新しい機能は別ブランチで作るという単純なルールですが非常に便利です。

そもそも、このフローの何が良いのか？

• masterブランチには常に動作するソースコードがある
  • subversionであったいつのリビジョンなら動いたっけ？みたいなことはない
• 機能はブランチで管理しているので現状が分かりやすい
  • masterからどれぐらい離れているかもすぐに分かります
  • そのため離れ過ぎたらmasterのソースをfetch-mergeということもしやすいです
• ブランチ単位なので定期的にコミットできる

ちなみに、subversionでもこのフローはできますがgit/githubは非常に簡単にできます。
マージされたブランチがなくなるというのは、ちゃんと1本道になったんだなと分かる点で良いですね。

　参考

• GitHub Flow (Japanese translation)