MacBookProでVsCode + Githubによる開発環境を整える

はじめに

SageMakerノートブックインスタンスの開発はお金がかかるので、
MacbookProで開発を進めたいときってありますよね？

そのための導入手順です。

手順

Visual Studio Codeをインストールする
Gitをインストールする
Githubにアカウントを開設する
GitとGithubを連携させる
Visual Studio CodeでGithubを連携する

Mac版Visual Studio CodeでGitを使えるようにセットアップ
https://qiita.com/ykmchd/items/638275ec34cfd58a99e0

【初心者向け】GitHubにリポジトリを作成してVisual Studio Codeと連携するまで
https://www.micknabewata.com/entry/github/vscode-sync
いずれにせよGitHubでリポジトリを作るのは、VSCodeからは不可能で、GitHubのサイトに訪れて実行する必要があるようだ。

macでgitとgithubを連携させる
https://qiita.com/Lassieena/items/db7f4cf8d9b236643dd8

MacでGitHubを使う手順 – SSH Keysの登録 / リポジトリの作成 / 基本コマンド
https://mae.chab.in/archives/2306

手元のターミナルではgitからコミットできるけど、VScodeからはどのように実施するんだろう。。。

どの単位でGitHubのリポジトリを作成すべきか

https://miau.hatenablog.com/entry/20100706/1278444362
ポイントは、git cloneはリポジトリ単位となること

＜ケース1＞
GitHubにすでにあるリボジトリを読みこんで、ファイルを編集して連携（push）する
MacbookPro+VSCode側=ローカルリポジトリ
GitHub側=リモートリポジトリ

VSCode側で、リモートリポジトリを登録する
ローカルリポジトリの内容を、リモートリポジトリにプッシュする。

VSCodeで作成したコードをgithubに連携（push）する

このような画面が表示される。

echo "# test" >> README.md
git init
git add README.md
git commit -m "first commit"
git remote add origin https://github.com/roe-river/test.git
git push -u origin master

ローカル環境で上記を実行すると、README.mdがgithubにpushされる。

git init
は、リポジトリの初期化。実行したディレクトリに.gitディレクトリが作成される。この.gitディレクトリに現在のディレクトリ以下を管理するリポジトリデータが格納される。

Gitではこのディレクトリ以下をこのリポジトリに付随したワークツリーと呼び、ワークツリーでファイルの編集などを行う。

git add ステージ領域へファイルを追加
Gitリポジトリのワーキングツリーでファイルを作成しただけでは、Gitリポジトリのバージョン管理の対象としてファイルは登録されていない。
そこで、ファイルをGitリポジトリの管理対象とするためにgit addコマンドを利用して、ステージ領域（インデックス）と呼ばれるコミットをする前の一時領域にファイルを登録する。

git commit　リポジトリの歴史を記録
ステージ領域に登録されている時点のファイル群を実際にリポジトリの歴史として記録する。

git remote add リモートリポジトリを登録
git remote add <識別子> gitパス
で、以後<識別子>で、gitパスのリモートリポジトリを指すようになる。

git push リモートリポジトリへ送信
現在のブランチのローカルリポジトリの内容をリモートリポジトリに送信する。
上記のgit pushコマンドを実行すると、originという名前のリモートリポジトリのmasterブランチに現在のブランチの内容を送信する。
-uオプションは、ローカルリポジトリの現在のブランチのupstream（ローカルで作業しているブランチの上流）はoriginリポジトリのmasterブランチであるということを同時に設定したことになる。
このオプションを付けることにより、リモートリポジトリの内容を取得するgit pullコマンドを実行するときに特にオプションを与えずとも、このローカルリポジトリのブランチはoriginのmasterブランチから取得するようになる。

Visual Studio Code から GitHubへのソース送付

GitHubとVSCODEの連携方法

https://qiita.com/yu0313/items/4f95fc0b7e544c42e107
GitHub側でリポジトリを作成し、VSCode側で
git clone -> Staging -> Commit -> Push
のStepを分かりやすく記載している。

プルリクエストするには

GitHubを使うなら最低限知っておきたい、プルリクエストの送り方とレビュー、マージの基本 (1/2)
https://www.atmarkit.co.jp/ait/articles/1702/27/news022.html

参考

VSCode小ネタ

・拡張子.ipynbだと、jupyterライクなUIになる。
・python Interactiveシェルを使うと、変数の値を確認しながら実行できる。（が、デバッガでよくない？）

AWS toolkit

VS-CODE上でSDKを使った開発を効率化できる
https://aws.amazon.com/jp/visualstudiocode/