はじめに
本稿はリポジトリにGithubを、クライアントツールとしてVisual Studio 2015を、構成管理ワークフローにGitflowを利用する場合の、主にVisual Studioの利用方法を記載した記事になります。
GitのプラグインとしてのGitflowには一切触れる予定はありませんのでご注意ください。
ことの発端は、Qiitaで公開している画像処理系のTipsのコードサンプルをちゃんと公開しようと考えたことがひとつ。
もうひとつは、職場の構成管理環境の一部に、いまだにVSSなんていう旧石器時代の遺物が利用されているので、今年こそは移行してやろうと目論んでいたことから、一度手順をきちんとまとめないと、と考えていたためです。
VSS以外にはCVS・Subversionなんかも利用してはいますが、基本的に集中型の構成管理システムを利用してきたので、分散型の構成管理はあまり経験がありません。
なので色々間違っているかもしれませんので、何かあれば絶賛突っ込みください。
もっともこれから公開しようとしているコードは、絶賛ボッチで開発することになるんで、Gitflowなんて不要なんですけど!(。A 。 )
そ、そこはノウハウを仕事に転用をですね。。。
なお、本稿ではGitflowのすべてのワークフローについて書ききれませんでした。
本稿では以下を記載しています。
- Githubへリポジトリの作成
- ローカルへクローンの作成
- developブランチの作成
- フィーチャーブランチの作成
- フィーチャーブランチへリソースの作成とローカルリポジトリへのコミット
- ローカルリポジトリのコミットのリモートへのプッシュ
2016.01.24 追記
第二回はこちら
Visual Studio 2015とGithubでGitflow(No.2)
前提条件
- GitクライアントツールとしてVisual Studio 2015 Communityエディションを利用します
- 事前にVisual Studio 2015 Communityエディションがインストールされているものとします
- リポジトリとして、Githubを利用します
- 事前にGithubのユーザ登録が完了していることを前提とします
- Gitflowのワークフローに対する知識を一定以上所持している方が読む前提として記述しています
- Gitflowのワークフローに関しては、以下のサイトを参考にさせていただきました! Atlassian社さん Gitチュートリアル Gitワークフロー
Githubにリポジトリを作成する
Githubに新しいリポジトリを作成するところから始めます。
まずはGithubにログインし、「New repository」ボタンを押下します。
その後、必要事項を入力して「Create repository」ボタンを押下します。
上の画像では、ライセンスにMIT Licenseを選択していますが、そこは各自のポリシーに合わせて選んでください。
gitignoreは、今回はVisual Studioから設定する想定なのでNoneでOKです。
「Create repository」を押下してリポジトリを作成したら、以下の画面の赤枠でくくった場所のボタンを押下して、リポジトリのパスをコピっておきます。
Github上での操作は、ひとまず以上です。
リポジトリをローカルにクローンする
Githubに作成したリポジトリを、ローカルにクローンします。
まずはVisual Studioを起動し、チームエクスプローラータブを開きます。
チームエクスプローラータブを開いたのち、「ローカルGitリポジトリ」の「複製」を押下します。
すると以下のように画面が表示されます。
「複製するGitリポジトリ~」と表示されているテキストボックスに、先ほどGithub上でコピーしたリポジトリのパスを貼り付けます。
貼り付けた下のテキストボックスが、ローカルにクローンされるリポジトリのパスになるので、適宜必要に応じて修正してください。
その後、「複製」ボタンを押下し以下の画面が表示されれば、クローンは正常に完了です。
Visual Studio上のGitのグローバル設定
これ以降の、ブランチを作成したり、コードをコミットするためには、Visual Studio上で、Gitのグローバル設定を行う必要があります。
まずは下図の赤枠のホームアイコンを押下してください。
この後、ホームボタンはよく出てくるので覚えておいてくださいね!
その後、「設定」ボタンを押下します。
下図の画面が表示されるので、ユーザ名とメールアドレスに適切な値を設定後、「更新」ボタンを押下しましょう。
developブランチの作成
続いて開発の中軸となる、developブランチを作成します。
手順的には、まずローカルリポジトリにブランチを作成したのちに、リモートにプッシュします。
まずはホームアイコンを押下してから、下図の「ブランチ」ボタンを押下してください。
ちなみに、上に表示されているサードパーティ製うんぬんは、Visual Studioから実行できないGitのコマンドがあるため、インストールしたほうが良いんでしょうけど、今回はあくまでVisual Studioからの操作がテーマなため、インストールしません。
けど、「今後表示しない」にして、後で泣くといやなチキンな私は、断固そのまま放置します!(。A 。 )
さて、ブランチメニューが表示されたら、下図の通りブランチを作成するローカルリポジトリを右クリックし「新しいローカルブランチ...」を押下してください。
以下の画面が表示されるので、「ブランチ名を入力してください<必須>」テキストボックスに「develop」と入力し、「ブランチの選択」プルダウンから「master」を選択して「ブランチの作成」ボタンを押下してください。
これで「master」ブランチの最新の状態をベースとしたブランチが作成されます。
以下の図のように、ローカルにdevelopブランチが作成されたはずです。
このままでは、ローカルリポジトリに作成されただけで、リモート側にはまだ反映されていませんので、次はリモートへ作成したブランチをプッシュします。
ホームボタンを押下して、以下の画面から「同期」ボタンを押下してください。
その後、同期画面内の「出力方向のコミット」→「公開」ボタンを押下します。
すると、以下のような認証画面が表示されます。
ここで、Githubの認証情報を入力しましょう。
次のように表示されれば、リモート(Github)上にブランチがプッシュされているはずです。
Github上で確認すると、以下のようにdevelopブランチが正常に作成されていることが見て取れます。
Visual Studio上で確認するには、「ホーム」→「ブランチ」から確認すると、以下のようにリモートにもdevelopブランチが作成されていることが確認できます。
フィーチャーブランチの作成
ここまでで、やっと実装を開始できるだけの準備が整いました。
ということで、機能の作りこみをするためのフィーチャーブランチを作成します。
といっても、本稿ではVisual Studioのソリューションを作るだけですけどね!
と言うわけで、developブランチを作成した時と同様に、ブランチを作ります。
ブランチの名前はひとまずdevelop-create-new-solutionとでもしておきます。
- リポジトリを右クリックして、「新しいローカルブランチ...」を選択
- ブランチ名に「develop-create-new-solution」、ブランチの選択に「develop」を選択し、ブランチを作成
- 「ホーム」→「同期」画面の、「出力方向のコミット」→「公開」から、リモートリポジトリへ、前述のブランチをプッシュする
という手順でブランチを新たに作成します。
ここで気をつけて?いただきたい事として、この時点で新たに作成したブランチを「チェックアウト」(選択?)された状態になっているということです。
改めてチェックアウトしなおす必要はありません。
なお、現在選択されているブランチは、Visual Studioの右下をみるとわかります。
またチェックアウトするためには、ブランチを右クリックしたコンテキストメニューから実行できます。
リソースの作成~ローカルリポジトリのコミット
さて、それではVisual Studioのソリューションを作成し、ローカルのリポジトリへコミットします。
なおVisual Studioでは基本的にステージングは行わず、直接ローカルリポジトリへコミットされます。(というか、同時に行われると言ったほうがよいのかも?)
ソリューションは、リポジトリの直下には作らず、Srcディレクトリを作成し、その下にソリューションディレクトリを作成します。
ソース以外のリソースも合わせて構成管理したいので、ディレクトリを分けます。
(ボッチプロジェクトには不要でしょうけど。。。)
下のような感じでソリューション(プロジェクト)を作成します。
「場所」を見ていただくとわかると思いますが、作成先はリポジトリをクローンしたローカルのパスの下に作成します。(これが良いのかイマイチ良くわからないんですけど。。。まぁ意図したことは一応できます。)
ここで、エクスプローラでローカルリポジトリを開いてみてください。
以下のように、.gitignoreファイル等がVisual Studioによって自動的に作成されているのが見て取れます。
ソリューションをローカルリポジトリにコミットするだけなら、Visual Studioのソリューションエクスプローラからソリューションを右クリックし「コミット」すれば良いのですが、今回は.gitignoreファイル等もコミットしたいので、チームエクスプローラから「ホーム」→「変更」を開きます。
ここでコミットメッセージを入力し、「コミット」ボタンを押下することで、ローカルリポジトリへコミットされます。
なお、ステージングとコミットを同時に実行するだけではなく、プッシュまで同時に行うこともできます。
下の図のように、「コミット」ボタンの右をクリックして切り替えることができますが、ここでは単純にコミットのみを実施します。
この時点では、リモートへはまだプッシュされていません。
リモートリポジトリへのプッシュ
それでは、ローカルリポジトリへのコミットをリモートリポジトリへプッシュします。
チームエクスプローラの「ホーム」→「同期」を押してください。
ここで、「出力方向のコミット」→「プッシュ」を押下します。
次のように表示されればプッシュは成功です。
Githubのページから参照してみましょう。
確かに、リモートリポジトリまでプッシュされていることが確認できましたね!
ということで、今回はここまで。
次回はフィーチャーブランチからdevelopブランチへのプルリクエスト以降を書きたいと思います。
思ったよりなげぇな。。。