GitHub Desktop を使って履歴管理を行う[基本編]
公開: 2025-02-16 17:05:10
GitHub Desktop というアプリケーションがあり、これでもリポジトリの履歴を管理することができます。具体的には、「History」タブを見ると、どんな変更をしたのかふりかえることが可能で、メニューから、あるいは右クリック(ダブルタップ)して、やりたいことを選ぶだけです。このドキュメントは、リポジトリを作成し、main に Commit、Push、Pull をして最新状態に保つまでを扱うためにあります。
なお、GitHub Desktop というときには、アプリケーションのことを指し、単に GitHub というときには、Web 版の リモートの GitHub 本体のことを指します。
0. 事前に行うこと
- GitHub の アカウントを作成 します
- GitHub にログインし、新規にリポジトリを作成します
- GitHub Desktop を 公式サイト の指示にしたがい、ダウンロード、インストールします
- GitHub Desktop にログイン(GitHub Desktop → Settings → Account からログイン)します
1. GitHub Desktop でリポジトリのクローンをつくる
- GitHub Desktop を開きます
- [File] → [Clone repository] を選択します
- [GitHub.com] タブを選ぶと、自分で作成したり、招待を受けたりしたリポジトリがリストに表示されているので、クローンを作成したいリポジトリを選択します(図1)
- クローン先(ローカルマシン)のディレクトリを指定(
~/Documents/GitHub/
の下に作成することが多いです=デフォルトのままで問題ありません)し、[Clone] をクリックします(図1) -
ローカルにリポジトリのコピーが作成され、クローン作業が完了します
図1. リポジトリのクローンをつくる 自分で作成したリポジトリや招待されたリポジトリのみクローンをつくることができます。
✔ ポイント
- クローンとは GitHub 上のリポジトリ(リモートリポジトリと呼びます)を 自分のマシン(ローカル)にコピーすること
- ローカルで作業した内容がリモートリポジトリに反映されるようになる
2. クローンしたローカルディレクトリに変更を加える
- 何かファイルをクローンしたローカルディレクトリに置いてみます(図2)
-
適当なファイルを CotEditor や VSCode などで編集してみます(他のアプリケーションを使うときと同様に、適宜保存してください; 図3)
図2. ローカルディレクトリでで編集作業を行う Finderでファイルを新たに置いたり(この例では、svgファイル)、編集したりすることができます。README.md を開くと次の図3のようになります。
図3. VSCodeのエディタで編集作業を行う エディタは好みのものでよく、これに限りません。この例では、README.md に1行追記しています。
✔ ポイント
- 編集作業そのものを必ずローカルディレクトリのなかで行う
- 4番以降を実行するまでは変更過程を他の誰もみることはできないので安心してよい
3. Commit する
- GitHub Desktop を開きます → 変更が検出されています(図4)
-
Summary 欄に変更内容を説明するメッセージを入力(例: 東京の気候値を追加)し、[Commit to main] をクリックします(図5)
図4. ローカルディレクトリの変更は即座に検知される 作業をローカルディレクトリで行うと、どんな変更を行なったかを自動的にリスト表示してくれます。
図5. main に Commit する Summary にはごく簡単に何を変更したかがわかるように記します(日本語でも構いません)。すると、[Commit to main] のボタンを押すことができるようになります。
✔ ポイント
- Commit は変更内容をローカルに保存すること
- Commit してもまだ GitHub にはアップロードされていない
4. Push して GitHub に反映させる
- 右上の [Push origin] をクリックします(図6)
- GitHub の Web ページでリポジトリを開き、変更が反映されたことを確認します(図7)
-
GitHub Desktop の場合、History タブをみると、同様に変更が反映されていることがわかります(図8)
図6. Commit の内容を Push する Commit に問題がなければ、Push origin を押して、main に反映させます。Commit の内容を修正したい場合には Undo ボタンを押します。
図7. main に Push されたかを確認する1 GitHub 上を確認(ブラウザをReload)すると、Mac の Finder 上の操作結果が反映されていることがわかります。
図8. main に Push されたかを確認する2 GitHub Desktop の Histroy タブ をクリックすると、右側にどのような変更が加わったかを知ることができます。慣れると、ブラウザを使わず、GitHub Desktop のみで確認できるようになります。
✔ ポイント
- Push はローカルの変更を GitHub にアップロードすること
- 他のメンバーもこの変更をみることができるので、以降共同での作業が可能となる
5. Pull してローカルを最新状態に保つ
- 自身あるいは共同メンバーがファイルを更新したり、追加、削除を行うと、自動でリストとともに、 [Pull origin] ボタンが表示されているはずです(図9)
- 最新の変更があるかわからない場合には、右上の [Fetch origin] をクリックします(図10)
- 変更がなければそのまま、変更があれば [Pull origin] が表示されているので、これをクリックします(図9)
-
同期したファイルを確認します(図11)
図9. main に 変更があると自動的に Pull するように促される リモートリポジトリに変更があるので、まずはローカルにも同期をとり、その後、履歴を確認します(図11)。
図10. 手動でリモートリポジトリに変更があるか確認する リモートリポジトリに変更があるかどうかわからない場合、Fecth することで、Pull する必要があるかないかがわかります。変更がある場合には、Pull のボタンが現れ、ない場合には何の変化もありません。
図11. リモートリポジトリの変更をローカルにも反映させる ローカルに Pull することで、リモートリポジトリにどのような変更があったかを知ることができます。この例では、README.md に(図8と比較すると)さらに1行追加されていたということがわかります。
✔ ポイント
- Pull は最新(自分の別のローカルマシーンでの作業、共同メンバーの作業)の状態に更新するボタンと考えてよい
- Pull せずに作業すると、古い状態を元に編集してしまう(かえって混乱する)
- Push の前に Pull する習慣をつける(Pull → Edit → Commit → Push)