とほほのGitHub入門

• トップ
• GitHub入門

• GitHubとは
• 無料プランと有料プラン
• アカウントを作成する
• アクセストークンを作成する
• ユーザ情報を設定する
• リポジトリを作成する
• リポジトリを更新する
• ブランチを作成する
• プルリクエストを送る
• GitHub Pagesを利用する

GitHubとは

• GitHub社によって提供される、Git ベースのソースコードリポジトリサーバ。
• 個人や法人で開発したソースコードを登録、公開できる。
• 無料(Free:$0)、プロ(Pro:$7)、チーム(Team:$9)、企業向け(Enterprise)などの料金プランを選ぶことができる。
• GitHub社は、2018年に 75億ドルでMicrosoft社が買収。

無料プランと有料プラン

無料プラン(Free)では下記を利用することができます。(2019年12月8日時点)

• 無制限のパブリックリポジトリと、無制限のプライベートリポジトリ
• プライベートリポジトリの場合は、共同編集者最大3名に制限
• 最大 2,000分/月のアクション実行時間
• 最大 500MBのストレージ
• パブリックリポジトリの場合は、アドバンスド脆弱性スキャンを提供
• 自動セキュリティアップデート
• GitHubセキュリティアドバイザリ
• イシュー＆バグトラッキング
• プロジェクト管理機能

プロ(Pro)では下記の様になります。

• 共同編集者が無制限となる
• アクション実行時間が、最大2,000 → 3,000分/月となる
• ストレージ容量が 500MB → 1GB となる
• プライベートな GitHub Pages と Wiki を利用可能
• プライベートな protected ブランチ
• コードオーナー (コードレビューアの指定)
• リポジトリインサイト

アカウントを作成する

1. https://github.com/ にアクセスする。
2. [Username], [Email], [Password] を入力して [Sign up for GitHub] ボタンを押す。
3. [検証開始] ボタンを押してロボットでないことを証明する。
4. [Next Select a plan] ボタンを押す。
5. [Free](無料)、または [Pro](有料) プランを選ぶ。
6. [Welcome to GitHub] ページで、プログラミング経験、利用目的、興味のあるキーワードを入力して [Complete setup] ボタンを押す。
7. メールが送られてくるので、メールに記載された URL をクリックして、メールアドレスが自分のものであることを証明する。
8. [Create a new repository] 画面が開くので、test などのリポジトリ名を入力する。
9. [Initialize this repository with a README] のチェックボックスをチェックする。
10. [Create repository] ボタンを押す。

アクセストークンを作成する

GitHub に git コマンドからID/パスワードでアクセスしようとすると下記のエラーとなります。

remote: Support for password authentication was removed on August 13, 2021.

2021年8月13日以降、ID/パスワードによる認証は廃止され、アクセストークンが必要になったためです。下記の手順でアクセストークンを取得してください。

• ブラウザから GitHub にログインする。
• 画面右上の自分のアイコンをクリックして [Setting] をクリックする。
• 左メニュー下部の [Developer settings] をクリックする。
• [Personal access tokens] をクリックする。
• [Tokens] をクリックする。
• [Generate new token] - [General new token(classic)] をクリックする。
• [Note] に自分が覚えやすいメモを記入する。
• 期限(Expiration)を 30 days にすると30日間有効なトークンが発行される。
• [Select scopes] に最低限 repo にチェックをつける。できれば admin:repo_hock と delete_repo も。
• [Generate token] ボタンを押す。
• 表示されたトークン(ghp_xxxxxxxx)をコピペして覚えておく。一度しか表示されないので注意。

取得したアクセストークンを下記の様に設定します。

• git コマンドを使用する場合は、https://{アクセストークン}@github.com/... でアクセスする。
• VSCode を使用する場合はパスワード入力時に、パスワードの代わりにアクセストークンを入力する。
• Windows の場合は [設定]-[設定の検索] から [資格情報マネージャー] を検索・実行し、[Windows 資格情報]-[git:https://github.com]-[編集] から [パスワード] にアクセストークンを入力する。

ユーザ情報を設定する

下記のコマンドでユーザ情報を設定しておきます。

$ git config --global user.email "yamada@example.com"
$ git config --global user.name "Yamada Taro"

リポジトリを作成する

• Home で画面左の [Top Repositories] の横にある [New] ボタンを押す。
• [Repository name] を入力する。
• [Public](公開) か [Private](非公開) かを選択する。デフォルトは [Public] なので注意。
• [Add a README file] にチェックをつける(おススメ)。
• [Create repository] ボタンを押す。

リポジトリを更新する

GitHubからソースコードをcloneします。

$ git clone https://{アクセストークン}@github.com/ユーザ名/リポジトリ名.git
$ cd リポジトリ名

Gitのファイルは、[WORK] →(add)→ [STAGING(INDEX)] →(commit)→ [LOCAL] →(push)→ [REMOTE] の流れで修正していきます。詳細は 「とほほのGit入門」を参照してください。

WORKでファイルを編集・追加します。

$ vi ./README.md

WORKとSTAGING(INDEX)の差分を確認します。

$ git diff

追加・編集したファイルを WORK から STAGING(INDEX) に追加(add)します。

$ git add ./README.md

STAGING(INDEX)とLOCALの差分を確認します。

$ git diff --staged

STAGING(INDEX) から LOCAL にコミット(commit)します。-m の後ろにはメモを記述します。

$ git commit -m "Commit test"

LOCAL から REMOTE にプッシュ(push)します。

$ git push

ブランチを作成する

• ブラウザで GitHub にログインして該当のリポジトリ画面を開く。
• 画面中央の [Branches] をクリックする。
• [New branch] ボタンを押す。
• [New branch name] にブランチ名を入力して [Create new branch] ボタンを押す。

ブランチ名には下記などが使用されます。

main - メインブランチ
develop-v1.2.0 - v1.2.0の開発ブランチ
feature-xxxx 機能毎の開発ブランチ
hotfix-xxxx バグフィックス

プルリクエストを送る

下記などのブランチ間のマージを直接行うのではなく、プルリクエスト（マージ要求）を投げて、しかるべきメンバがチェックした後にマージを許可することができます。

• メインブランチ(main)に v1.2.0ブランチ(develop-v1.2.0) をマージする。
• v1.2.0ブランチ(develop-v1.2.0) に機能ブランチ(feature-F0123) をマージする。
• メインブランチ(main)にバグフィックスブランチ(hotfix-B12345)をマージする。

例えば hotfix-B12345 を main にマージしたい場合のプルリクエストは下記の手順で行います。

• GitHub で該当のリポジトリページを開く。
• 上部メニューの [Pull requests] を押す。
• [New pull request] ボタンを押す。
• どのブランチからどのブランチにマージしたいかを選択して [Create pull request] ボタンを押す。
• タイトルや説明文を入力して [Create pull request] ボタンを押す。

プルリクエストの承認は下記の手順で行います。

• GitHub で該当のリポジトリページを開く。
• 上部メニューの [Pull requests] を押す。
• プルリクエストのタイトルをクリックする。
• 変更内容を確認し、[Merge pull request] ボタンを押す。
• 内容を確認して [Merge pull request] ボタンを押す。
• 必要に応じてコメントを記入して [Confirm merge] ボタンを押す。

GitHub Pagesを利用する

GitHub に登録した静的コンテンツを GitHub Pages として公開することができます。

1. https://github.com/ユーザ名/リポジトリ名 にアクセスします。
2. [Settings] → [GitHub Pages] → [Source] で [master branch] を選択します。
3. https://ユーザ名.github.io/リポジトリ名/ としてアクセスできるようになります。

コードを変更した場合、再度上記を行うことで GitHub Pages を更新することができます。