GitHub Desktop 操作方法
このファイルは、PersonalHomepage プロジェクトで GitHub Desktop を使うための操作メモです。
GitHub Desktop とは
GitHub Desktop は、SourceTree と同じように Git を GUI で操作するためのソフトです。
主な役割は次のとおりです。
- 変更されたファイルを見る
- 変更内容を確認する
- コミットを作る
- GitHub に push する
- GitHub から fetch / pull する
- コミット履歴を見る
SourceTree と比べると、GitHub Desktop は GitHub 連携に特化していて、画面や機能がシンプルです。
このプロジェクトでの基本方針
- 作業やファイル編集は Codex またはエディタで行う。
- Codex がローカルコミットまで行うことがある。
- GitHub への push は GitHub Desktop の Push origin を使う。
- PowerShell の
git pushは、会社用 GitHub 認証と混ざる可能性があるため基本的に使わない。
画面で確認する場所
Current repository
左上にあるリポジトリ名。
このプロジェクトで作業するときは、必ず PersonalHomepage になっていることを確認する。
Current branch
上部中央付近にある現在のブランチ名。
通常は main を使う。
Changes
まだコミットしていない変更を見る場所。
ファイルを編集すると、ここに変更ファイルが表示される。
History
過去のコミットを見る場所。
Codex がコミットを作成した後は、ここに新しいコミットが表示される。
Fetch origin / Pull origin / Push origin
上部に表示されるボタン。
- Fetch origin
- GitHub 側に新しい変更があるか確認する。
- 変更を取り込む前の確認操作。
- Pull origin
- GitHub 側の変更をローカルに取り込む。
- Push origin
- ローカルのコミットを GitHub に送る。
このプロジェクトでは、Codex がコミットした後に Push origin を押すことが多い。
Codex がコミットまで行った後の操作
1. GitHub Desktop を開く。
2. 左上の Current repository が PersonalHomepage であることを確認する。
3. 上部の Current branch が main であることを確認する。
4. History タブで新しいコミットが追加されていることを確認する。
5. 上部に Push origin が表示されていたら押す。
6. GitHub のページでファイルが更新されているか確認する。
自分でコミットする場合
1. ファイルを編集する。
2. GitHub Desktop の Changes タブを開く。
3. 変更されたファイル一覧を確認する。
4. 左下の Summary にコミットメッセージを書く。
5. 必要なら Description に詳細を書く。
6. Commit to main を押す。
7. 上部に Push origin が表示されたら押す。
コミットメッセージの例
docs: update work log
feat: add profile page
fix: correct navigation link
日本語で書いても問題ない。
docs: GitHub Desktop の操作方法を追加
GitHub のページを開く
GitHub Desktop の画面右側にある View on GitHub を押すと、ブラウザで GitHub リポジトリを開ける。
ファイルが GitHub に反映されたか確認するときに使う。
注意点
- 別リポジトリを操作しないように、最初に必ず Current repository を確認する。
- 会社用リポジトリと混ざらないように、この個人サイトでは GitHub Desktop を使う。
- Windows の資格情報マネージャーから GitHub 関連の資格情報を削除しない。
node_modules/、dist/、.astro/は Git 管理しない。- 変更内容がよく分からないときは、すぐにコミットせず、先に内容を確認する。
困ったとき
Push origin が表示されない
未 push のコミットがない状態。
GitHub に反映済みか、まだコミットが作られていない可能性がある。
Changes にファイルが表示される
未コミットの変更がある状態。
内容を確認して、必要ならコミットする。
Repository not found が PowerShell に出る
PowerShell 側の Git 認証が会社用 GitHub と混ざっている可能性がある。
このプロジェクトでは PowerShell から push せず、GitHub Desktop の Push origin を使う。