自分で作ったコードをとりあえずGitHubで管理したい #Windows

はじめに

GitHubはチームで開発を進める際に利用するバージョン管理ツールとして有名だが
自身で作成したプログラム等の成果物を公開するといった利用方法もあると思う。
ここでは、後者の目的でGitHubを利用したい人向けに最低限の操作方法を紹介する。

筆者の使い方

筆者は仕事上VBAを用いることが多いので、自宅で作成したソースコードやツールを

下記のような階層構造でGitHubのリモートリポジトリにアップロードしている。

リポジトリ階層構造

VBA	
 ├ lib                            …どこからでもコードをコピーできるようにエクスポートしたモジュールを配置
 │  ├ class	
 │  │  ├ clsArrayList.cls	
 │  │  ├ clsIterator.cls	
 │  │  ├ …	
 │  │  …	
 │  ├ form	
 │  │  ├ …	
 │  │  …	
 │  └ module	
 │      ├ modFileUtils.bas	
 │      ├ modExclEditUtils.bas	
 │      …	
 ├ sample                         …Qiita等で記事を作成した際のサンプルプログラム等を配置
 │  ├ 【Qiita】サンプルファイル	
 │  ├ …	
 │  …	
 └ tools                           …ダウンロードすればそのまま利用できるツールを配置
     ├ VBエクスポートツール.xlam	
     ├ …	
     …

必要なもの

msysgit（Git for Windows）
GitHubアカウント

以降で紹介する手順には上記の用意が必要

GitHubのリモートリポジトリへの配置の手順

1. リモートリポジトリの作成
2. ローカルリポジトリの作成
3. リモートリポジトリにアップロードしたいファイルをローカルリポジトリに配置
4. リモートリポジトリを更新するためのアクセストークンを発行する
5. ローカルリポジトリの内容をリモートリポジトリにアップロード

1. リモートリポジトリの作成

リモートリポジトリとは

ここでは「ネット上にある自分用のフォルダ」という解釈でOK

1.1. GitHubのログイン直後のページから下記のように操作

① リポジトリ名を決める（既存のリポジトリと重複しなければ何でもOK）
② Publicを選択（Privateだとログインしないと閲覧できない）
③ Create a new repository ボタンを押下してリモートリポジトリを作成

リモートリポジトリが作成された

Public 指定をすると、赤の他人でも見ることができてしまうので注意

2. ローカルリポジトリの作成

ローカルポジトリとは

「ローカルリポジトリとして利用すると宣言した、自身のPC上にあるフォルダ」
自身のPC上のファイルやフォルダを、リモートリポジトリに配置するための橋渡しとしての役割を持つ

2.1. 適当なフォルダを開き、ターミナルを開く

下記の赤枠内には、ターミナルを開いたときのフォルダ階層が表示されている

※※※※※コマンドを実行する場所※※※※※
以降の手順でコマンドを実行する際は、全て上記のパスから実行する必要があるため注意
（ターミナル(PowerShell)を開くとき、右クリックするフォルダは必ず今回と同じにすること）

アプリケーションについて
手順では「ターミナル(PowerShell)」を指定してるが、実際は「コマンドプロンプト」や「Git Bash」でも、
「Git」コマンドを打って反応があるアプリケーションなら何でも良い。

2.2. 下記のコマンドを入力

コマンド

git init               #ローカルリポジトリの作成

下記のようなメッセージが出れば成功

3. リモートリポジトリにアップロードしたいファイルをローカルリポジトリに配置

ローカルリポジトリは、自身のPCとリモートリポジトリを繋ぐ橋渡しの役割を持つと説明したように
今回紹介する作業では、最終的にローカルリポジトリの内容 = リモートリポジトリの内容となる

3.1. 好きなようにファイルを配置する

先ほどの手順で「git init」を実行したフォルダ配下にファイルやフォルダを配置する
（空のフォルダだけだとアップロードされないので注意）
下記はフォルダ配下にファイルが入ってる

.gitについて
先ほどの手順「git init」のコマンドによって作成された。
隠しファイルを表示することによって可視化できるが、見えるようにしなくても問題ない。

3.2. 下記のコマンドを入力

コマンド

git add .              #フォルダ内全てをローカルリポジトリに仮配置

3.3. 続けて下記のコマンドを入力

コマンド

git commit -m "任意のコメントを入力"    #3.2. で仮配置したファイルを本配置

4. リモートリポジトリを更新するためのアクセストークンを発行する

リモートリポジトリは、アクセストークンを発行した際に表示されるキーワードを知る者しか更新ができない
下記はそのアクセストークンを発行するための手順となる

4.1. アカウントのアイコンを押下し、メニューから「Settings」を押下する

4.2. 遷移先のページの左下のメニューに「Developer settings」があるため押下する

4.3. 遷移先のページのメニューから「Tokens(classic)」を押下する

4.4. 右側に表示される「Generate new token ▼」を押下し、「Generate new token(classic)」を選択する

4.5. 遷移先のページで下記のように操作

① トークン名を決める（何でも良い）
② トークンの有効期限を決める（セキュリティの観点では短い方が望ましいが、更新が面倒であれば長くしても良い）
③ 利用目的を決める（今回の紹介内容だけの用途であれば「repo」にのみチェックする）
④ ボタン「Generate token」を押下する

　　　　　　　　　　　↓

トークンが発行される

発行されたアクセストークンのキーは必ず控えること
忘れると同じ手順で再発行する必要がある

5. ローカルリポジトリの内容をリモートリポジトリにアップロード

前項で取得したアクセストークンを用いてリモートリポジトリの更新をする

5.1. 下記のコマンドを入力

コマンド

#リモートリポジトリを操作する際の更新者としての情報を指定する
git config --global user.name "任意のユーザー名"
git config --global user.email "任意のメールアドレス"

上記で指定した値はリモートリポジトリから他人も見ることができる

5.2. 下記のコマンドを入力

コマンド

git branch -M main         #ローカルリポジトリとリモートリポジトリのブランチ名を統一する

5.3. 下記のコマンドを入力

コマンド

#指定したリモートリポジトリを現在のローカルリポジトリと紐付ける
git remote add origin https://github.com/XXXX/XXXX.git

URLは下記で確認できる

5.4. 下記のコマンドを入力

コマンド

git push -u origin main            #ローカルリポジトリの内容をリモートリポジトリへ反映する

下記のアクセストークン入力画面が表示されるため、先ほどの手順で取得したアクセストークンのキーを入力する

下記のようなメッセージが表示されると成功

新たに更新する場合
次の手順を参照

3.1. ~ 3.3. → 5.4.
3.1.で更新したローカルリポジトリの内容をリモートリポジトリに反映することができる。

おわりに

以上の手順さえ覚えておけば、とりあえずGitHubのリモートリポジトリを私的に利用できると思う。
ただ、紹介した用語やコマンドの意味付けはやや説明不足な面もあるため、さらに深い用途でGitHubを利用する際には調べなおすことをおすすめする。