Githubを設定振り返り用ログ

Githubを設定した話

はじめに

この記事では、WSL2とVSCodeを使用してGitHub Pagesを設定し、運用する方法について解説します。Windows PCを新しくセットアップする機会に、GitHubの設定から運用までを一通り実践してみました。その過程で得た知見を共有させていただきます。

この記事は、2023年に公開したページを再編集したものです。
情報が古くなっている可能性がありますので、ご了承ください。

対象読者

• WSL2 × VSCode × GitHub を使い始めたい人
• GitHubにSSHで接続したい人
• GitHubに公開してあるリポジトリをクローン・編集したい人

環境構築

WSL2の設定

WSL2のインストールと初期設定は完了していることを前提とします。
まだの方は、Microsoft公式ドキュメントを参照してください。

VSCodeの設定

1. VSCodeをインストール
2. WSL拡張機能をインストール
3. GitHub拡張機能をインストール（最新のVSCodeには標準で含まれている場合があります）

GitHubとの連携

SSH鍵の生成と設定

まず、GitHubのリポジトリにアクセスするためにSSH鍵を生成します。

# SSH鍵を保存するディレクトリを作成
mkdir ~/.ssh
cd ~/.ssh

# RSA鍵を生成
ssh-keygen -t rsa

鍵の生成時に3回の入力を求められます：

1. 鍵の保存場所（デフォルトでOK）
2. パスフレーズ（セキュリティのため設定推奨）
3. パスフレーズの確認

生成した公開鍵をGitHubに登録します：

# Windowsの場合
clip.exe < ~/.ssh/id_rsa.pub

# Macの場合
cat ~/.ssh/id_rsa.pub | pbcopy

GitHubの設定手順：

1. GitHubにログイン
2. Settings > SSH and GPG keys
3. "New SSH key"をクリック
4. Titleに識別しやすい名前を入力
5. Keyにコピーした公開鍵を貼り付け
6. "Add SSH key"をクリック

接続テスト：

ssh -T [e-mail]

成功すると以下のようなメッセージが表示されます：

Hi username! You've successfully authenticated, but GitHub does not provide shell access.

GitHubアカウントの設定

Gitの初期設定を行います：

git config --global user.email "[e-mail]"
git config --global user.name "Your Name"

リポジトリの操作

リポジトリのクローン

1. GitHubで対象のリポジトリを開く
2. "Code"ボタンをクリック
3. "SSH"タブを選択
4. 表示されるURLをコピー

# リポジトリをクローン
git clone <コピーしたURL>

変更のコミットとプッシュ

ファイルを編集した後、以下の手順で変更を反映します：

# 変更したファイルをステージング
git add <ファイル名>

# 変更をコミット
git commit -m "コミットメッセージ"

# 変更をプッシュ
git push -u origin main

-u origin mainオプションを使用することで、次回からは単にgit pushで更新できます。

VSCodeでのGitHub操作

VSCodeのGUIを使用してGitHubの操作を行う方法：

1. 左側のSource Controlアイコン（分岐マーク）をクリック
2. 変更したファイルが表示される
3. "+"ボタンでステージング
4. コミットメッセージを入力
5. "Commit & Push"ボタンで一括操作

まとめ

この記事では、WSL2とVSCodeを使用したGitHub Pagesの設定から運用までの基本的な手順を解説しました。特に以下の点に注意して設定を行うことで、スムーズな開発環境を構築できます：

• SSH鍵の適切な生成と管理
• Gitの初期設定
• VSCodeの拡張機能の活用

これらの設定を行うことで、安全かつ効率的なGitHub Pagesの運用が可能になります。

参考リンク

• GitHub公式ドキュメント
• WSL2公式ドキュメント
• VSCode公式ドキュメント