とほほのGitHub入門

目次

GitHubとは

アカウントを作成する

  1. https://github.com/ にアクセスする。
  2. [Enter your email] にメールアドレスを入力して [Sign up for GitHub] をクリックする。
  3. [Email]、[Password]、[Username]、[Your Country/Region] を入力して [Create account] する。
  4. メールが送信されるので、メールに記載されたコードを入力して [Continue] する。
  5. [Username or email address] と [Password] を入力してログインする。

リポジトリを作成する

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

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

remote: Support for password authentication was removed on August 13, 2021.
remote: Invalid username or token. Password authentication is not supported for Git operations.

2021年8月13日以降、ID/パスワードによる認証は廃止され、アクセストークンが必要になりました。アクセストークンには下記の2種類がありますが、現在ではより細かなアクセス制御が可能な Fine-grained personal access tokens が推奨されています。

Tokens(classic)

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

Fine-grained personal access tokens

取得したトークンの使用方法は Token(classic) と同様です。

ユーザ情報を設定する

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

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

リポジトリを更新する

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

ブランチを作成する

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

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

プルリクエストを送る

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

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

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

GitHub Pagesを利用する

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

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

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