はじめに
ようこそ、分散バージョン管理「Git(ギット)」を、Macの統合開発環境である「Xcode」から利用するための基礎勉強です。Xcodeは、Mac、iPhone、iPadなど、Apple社製品向けのアプリケーションを作成する場合に必要となる、統合開発環境です。専用のGUIを備えており、GitもXcode内から直感的に扱うことが出来ます。
「Gitの基礎勉強〜Xcodeから、Gitによるバージョン管理を使う〜」では、Mac OS環境で Xcodeでの基本的なGitの使い方をご自身のマシンで動作させます。 Xcode はこのチュートリアルで説明している以外にも多くの機能を備えたパワフルなツールです。使いこなすためには文章を読むだけではなく実際に試すことがとても重要です。
このドキュメントにならってチュートリアルを実行することで、基本的な Xcode上でのGitの使い方を学習することができます。
このチュートリアルでは、Xcode の日本語版(XcodeVersion 11.4.1 )を利用して進めていきます。
レッスン 1. インストール
最初に Xcode が利用できるように環境を作ります。Xcode は、AppStore からダウンロードすることができます。
AppStoreアプリを開き、「Xcode」と検索してみてください。以下のような画面が見つかりますので、ダウンロードをしてください。
Xcode のインストール
Xcode のインストールは「Agree」を押下すれば問題ありません。
インストールの許可が必要な場合がありますが、Mac自体のパスワードを入力してください。
こちらの画面が出たら、Xcodeのインストールは完了です。
gitの初期設定
まずはGitの初期設定を実行します。設定はコマンドラインで実行します。環境設定の内容については説明しませんが Git を利用するために必要な手順として以下を実行します。Macの「ターミナル」Appを立ち上げ、以下
Git はコミット時にユーザ名とメールアドレスを記録します。この設定は必須です。自分が利用するメールアドレスと名前を設定します。
以下の内容を、ターミナルで入力してください。
git config -–global user.email "メールアドレス"
git config -–global user.name “あなたの名前”
- user.email … コミット時に利用されるメールアドレス
- user.name … コミット時に利用される名前
日本語の文字化け対策で設定します。
git config -–global core.quotepath false
改行コードを Git が自動変換することを無効にします。
git config -–global core.autocrlf false
push コマンド時にブランチ名やタグ名を指定しない場合の標準動作を設定します。(安全のため)
git config -–global push.default upstream
レッスン 2. ローカルリポジトリを作成
これでXcodeでGitが利用できるようになりました。Xcodeを使い、Gitでソースコードのバージョン管理を行うためにはリポジトリを用意する必要があります。ですが、Xcodeでは、プロジェクトの作成時に、併せてローカルリポジトリを作成することができるようになっています。
以下の手順を参考にしてください。
リポジトリ: Git で管理されるソースコードやファイルを格納する場所のことです。この格納場所を作成しなければ開発に進むことはできません。通常リポジトリの作成作業はプロジェクトの最初に1回だけ実行します。
それでは、プロジェクトの新規作成から、併せてリポジトリを作成します
新規プロジェクトを作成します。「Create a new Xcode project」をクリックします。
次に、どのようなプロジェクトを作成するかを選択します。今回は、最もシンプルな「Single View App」を選択します。
プロジェクトに関しての情報入力を求められます。ここでは、サンプルですので、「Product Name」などの空欄を埋めるだけで良いです。
次に、プロジェクトの保管場所を聞かれますので、任意のフォルダを指定してください。
また、この時「Create Git repository on my Mac」にチェックを入れるのを忘れないようにしてください。これにより、プロジェクトの作成と同時に、ローカルリポジトリも作成されます。
また、その際に先程のGitの初期設定がもし出来ていない場合、名前やemailの情報について、登録するように求められます。
その場合、指示に従い、名前とemailの登録を表示された画面で実施してください。
以上で、プロジェクトの新規作成は完了です。以下の初期画面になっていれば大丈夫なので、次のステップに進んでください。
最初のコミット
このあと、実際にXcodeを使って、ファイルの新規追加・編集・ファイル名変更・移動・削除などを行っていきますが、まずは初期状態をローカルリポジトリにコミットしておきましょう。
Xcode のメニューの「Source Control」から「Commit」を選択します。
Commitしたいファイルを選択します。(今回は初回なので、4ファイル全てにチェックを入れます。)
また、下の欄にコミットのメッセージを記入出来るので、「1st commit」など、どんな変更をしたかが分かる文言を入れます。
その後、右下の「Commit 4 file」をクリックします。
レッスン 3. 新しいファイルを作成・追加
ローカルリポジトリで開発を始めましょう。リポジトリには既にサンプルプロジェクトのファイルがいくつか存在していますが、ファイルを追加してみます。 以下のキャプチャに従って、新しいファイルを追加してみましょう。
まずは、「Test Project」のフォルダを右クリックし、「New File」を選択しましょう。
次に、追加するファイルの種類を問われますので、選択します。(ここでは、「Cocoa Touch Class」を選択します。)
「Next」を選択するとファイルの詳細設定を聞かれますので、記入してください。(ここでは、class名を聞かれているので、「test」と設定します。)
「Next」を選択するとファイルの保存場所を聞かれますので、プロジェクト内の任意の場所に保存してください。(ここでは、「test project」内に保存します。)
「Create」押下でローカルリポジトリに「test.swift」ファイルが追加されました。
また、ファイル名の横を見ると「A」、フォルダ名の横を見ると「M」の文字が見えます。
これは、それぞれ「A=Add(追加)」「M=Modify(変更)」という意味になります。
これで新しいファイルをローカルリポジトリに追加し、コミットする準備が出来ました。 これだけでは、ローカルリポジトリに反映していません。コミットをしなければリポジトリに反映されません。
それでは、コミットを行います。先程の最初のコミットと同様に Xcode のメニューから操作します。
コミット用のウィンドウが立ち上がりますので、コミット時の変更内容を入力します。追加や変更があったファイルにチェックがついていますので、コメントを書いたらそのまま「Commit 2 file」を押下し、コミットします。
コミットが完了しました。元のプロジェクト画面が表示されましたが、先程まであった「A」や「M」の文字が消えています。これで新しいファイルを追加し、ローカルリポジトリにコミットすることが出来ました。
ノート
コミット時のコメントは何を残すべきか?
コミット時に変更内容を記録するメッセージ領域が表示されます。
コミットするときは必ずコミット内容を説明する内容を記述するようにすべきです。具体的に、機能追加なのか、バグ対応なのか、仕様変更による変更なのかを記載するべきです。
人間の記憶はとても曖昧で1,2ヶ月前の作業について何をやっていたかは覚えていても、日々のコードレベルの修正など覚えていないーー覚えておく必要も無いのでーー場合がほとんどです。
コミット時に修正内容を記録しておくことは、チームみんなのためであり、将来の自分のためでもアルのです。
レッスン 7. 新しいディレクトリを作成・追加
ディレクトリの追加やディレクトリに含まれるファイル群の追加をやっていきます。 やり方はファイルの追加と同じです。
フォルダa,bとbフォルダに1つのテキストファイルを作成します。
「NewGroup」を選択して、新たに「a」「b」のフォルダを作成し、「b」フォルダの中には、test2.swiftなど新規ファイルを作成します。
作成が完了すると、また以下のように「M」や「A」といった表記が出ています。
フォルダaとフォルダbをリポジトリに追加するため、「Source Control」メニューから「Commit」コマンドを実行します。フォルダbにはテキストファイルが含まれていることに注意してください。
コミット時のメッセージを記入し、「Commit 2 file」します。
無事、「M」や「A」の文字が消え、コミットが完了しました。
レッスン 8. ファイルを更新
それでは、ファイルの中身を編集してバージョン管理システムの機能を見ていきましょう。追加した test.swift を開き、 コメントを追加します。
//comment add
ファイルを保存してください。 変更したファイルに「M」のマークがついています。
続いてコミットを行います。コミットは、「Source Control」メニューからだけでなく
もう一度同じファイル下部に以下の行を追加します。
//comment2 add
今編集しているファイルはリポジトリのファイルより新しい修正が追加されました。
コミットする前にその内容を確認します。今編集したファイルを見ると、追加された部分の左側に青い線が入っており、追加した部分がすぐに分かるようになっています。
また、もう少し細かく修正した部分を確認したい場合は、画面右上のマークをクリックすると、画面が左右に分かれ、修正履歴がわかりやすくなります。
修正内容を確認したらコミットします。更新内容のログを忘れずに入力します。