🐙

【備忘録】VSCodeとGithubを連携させる【Windows】

2025/01/12に公開

Git

AWS CDKを触る度に色々な記事を参照しているので自分用にまとめる。

前提条件

・OSはWindows
・VSCodeをインストール済み
・Githubのアカウント取得済み

VSCodeにgitをインストールする。

WindowsのVSCodeでターミナルはPowerShellで動いている(ターミナルの右上にもPowerShellって書いてる)ので【winget install git】でインストールしようとする。

すると、選択肢がいくつかあると言われるのでgitを指定してあげる必要がある。

こんな感じに

'msstore' ソースでは、使用する前に次の契約を表示する必要があります。
Terms of Transaction: https://aka.ms/microsoft-store-terms-of-transaction
ソースが正常に機能するには、現在のマシンの 2 文字の地理的リージョンをバックエンド サービスに送信する必要があります (例: "US")。

すべてのソース契約条件に同意しますか?
[Y] はい  [N] いいえ: Y
複数のパッケージが入力条件に一致しました。入力内容を修正してください。
名前   ID            ソース
----------------------------
My Git 9NLVK2SL2SSP  msstore
Git    Git.Git       winget
Git    Microsoft.Git winget

今回のようないわゆるリポジトリ管理ツールのgitはGit.Gitが該当するのでインストールコマンドは以下の通り。

winget install Git.Git

以下コマンドでバージョンが表示されればインストールは成功

git --version

仮にインストールが成功しててもエラーが出ることがあるのでその場合はVSCodeを再起動。

あるいは、PowerShellの実行権限周りでgitコマンドが使えていないのでそっち方面でトラブルシューティングするといいかも。

ちなみに毎回VSCodeの再起動をするのが手間な場合は、『Chocolatey』のrefreshenvコマンドを使えるようにしておくといいかも。

Chocolateyのインストールコマンドとインストール確認方法は以下の通り。

#インストール
Import-Module "$env:ChocolateyInstall\helpers\chocolateyProfile.psm1"

#確認（再起動が多分必要）
choco --version

VSCodeとGitHubアカウントの連携

VSCodeにGitHubのアカウント情報を登録する

git config --global user.name {GitHubのユーザー名}
git config --global user.email {GitHubアカウントのメールアドレス}

GitHub側で連携用のリポジトリを作成する。

名前などは任意でよいが公開予定がない場合はprivateリポジトリで作成するのが無難。

リポジトリが作成できたらリポジトリのページを開いてURLを控える。

VScode上でリポジトリを連携させる。

git remote add origin {リポジトリのURL}.git

VSCode‐GitHub間で初めての連携の場合はこのタイミングでGitHubのブラウザが立ち上がり、連携を許可しますか的な画面がでるはずなので許可する選択肢を選んで進める。

後はVSCode側でプッシュしたいフォルダなりファイルを作成してGitHubのリポジトリに保存ができるようになる。

備忘録としてその際のコマンドも残す

#対象フォルダ全てをステージングに追加
git add .

#対象ファイルのみをステージングに追加
git add {ファイル名.拡張子}

#コミットの作成
git commit -m "任意のメッセージ"

#リモートリポジトリ(GitHub)へプッシュ
git push origin main(or master)

その他メモ

#push originの部分はデフォルトの場合の話
#originかどうかは以下コマンドで確認
#git remote addの時に任意の文字列で設定可能
git remote -v

#push origin mainのmainも正しいかは以下で確認
git branch

#プランチ名を変更可能
#masterに変更したい場合
git branch -M master

#VSCodeとGitHubリポジトリの関連付けはフォルダ単位
#現在のフォルダが関連付けされているリポジトリは以下で確認可能
git remote -v

#リモートリポジトリをローカル(VSCode)に読み込む(クローン)
git clone {リポジトリのURL}.git

【備忘録】VSCodeとGithubを連携させる【Windows】

前提条件

VSCodeにgitをインストールする。

VSCodeとGitHubアカウントの連携

参考

Discussion