SSHキーを使用したローカルリポジトリとGitHubの連携

この一連の作業に関していい感じにまとめられたと思うので共有することにしました。
誰かの役に立てば幸いです。

はじめに

ローカルでGitの初期設定を行う


# Gitでは誰が変更したのかが重要である為ユーザー名とe-mailの設定が必須(変更可能)
git config --global user.name "your_username"
git config --global user.email "your_e-mail"

# 新規リポジトリのデフォルトブランチ名をmainに変更
git config --global init.defaultBranch main

# 正しく設定できているか確認
git config --list

補足(user.emailにnoreply アドレスを使う)
GitHub は Committer の判別にメールアドレス(git config の user.email)を使用している。
これを連携させないと、GitHub 上のログに本人のアバターが出ない。
しかし、自分のメールアドレスは登録したくないという人のために
GitHub 側にてダミーのメールアドレス(noreply アドレス) が用意されている。

1.GitHub にログイン
2.https://github.com/settings/emails を開く
3.「Keep my email address private」を ON にする
4.表示されたID+USERNAME@users.noreply.github.comのような形式のダミーアドレスをuser.emailに登録

SSHキーを使ってGithubと連携する

GitHub(リモートリポジトリ)とローカルを連携させるためにSSHキーを使って連携させる。
手順は以下の通り

1.ローカルのターミナルにてSSHキーを保存するディレクトリに移動
cd ~/.ssh

2.SSHキーをRSA形式で生成
オプションなし: ssh-keygen 
よりセキュアに生成: ssh-keygen -b 4096 -C "自身のuser.e-mailを指定"

※コマンドを実行してSSHキーを生成する際に
「SSHキーを保存するファイルのパス」と
「秘密鍵を保護するためのパスフレーズの追加」(push時にこのパスワードの入力が求められるようになる)
の確認がされる。
特別変更する必要がなければデフォルトのままEnterキーを押す。

3.公開鍵を表示しコピーする
cat ~/.ssh/id_rsa.pub

4.GitHubと連携する
GitHubにて
「https://github.com/settings/keys」ページで  
「New SSH keys」をして  
「Title」には任意の名前を付け  
「Key」にはコピーした公開鍵をペーストする。  
「Add SSH Key」を押下し完了。

補足

-bオプション(bits): 生成される鍵のビット数を指定(デフォルト値:2048)
-Cオプション(Comment): 生成される鍵に追加するコメントを指定(一般的に自身のe-mailを指定する)
id_rsa.pubファイル: SSHキーペアの公開鍵ファイル

さいごに

これらの内容は他の方の記事も存分に参考にさせて頂いてます。
ぜひそちらも参考にしてください。

参考