【初心者入門】GitHubの使い方と初回設定方法！無料でどこまで使えるか解説

まずは公式サイトにアクセスし、インストーラをダウンロードします。

自分の環境に合ったものをダウンロードしましょう。

ダウンロードしたインストーラを起動し、「Install」をクリックしてGitをインストールします。

インストールが完了したら、「Finish」をクリックして終了しましょう。

コマンドプロンプトを開き、以下のコマンドを実行してGitのバージョンが表示されればインストール完了です。

git --version

Gitをインストールすると、Git Bashというコマンドラインツールもインストールされます。

Git Bashを起動して初期設定を進めます。

以下のコマンドを実行することで、ユーザー名を設定します。

git config --global user.name "ユーザー名"

また、以下のコマンドを実行すると、メールアドレスを設定できます。

git config --global user.email "メールアドレス"

ユーザー名とメールアドレスを設定後、Git Bashを再起動して以下のコマンドを実行します。

git config --list

以下のようにユーザー名とメールアドレスが表示されれば、初期設定完了です。

GitHubの公式サイトにアクセスし、「GitHubに登録する」をクリックします。

メールアドレスやパスワードを入力し、「Continue」をクリックします。

登録したメールアドレスに認証コードが送られてくるので、入力して続けます。

サインイン画面に遷移するので、先ほど登録したメールアドレスかユーザー名と、パスワードを入力してください。

以上でアカウント登録は完了です。

GitHubでは、接続方法としてHTTPSとSSHが選べます。

SSH接続をするには、まずGit Bashで以下のコマンドを実行し、公開鍵・秘密鍵を発行します。

ssh-keygen -t rsa

ファイルの保存場所やパスワードを入力するように求められますが、何も入力せずにEnterを押しても大丈夫です。

以上で公開鍵・秘密鍵の作成が完了しました。

続いて作成した公開鍵をGitHubにアップロードします。

以下のコマンドを実行し、作成した公開鍵の内容を表示します。

cat /c/Users/ユーザー名/.ssh/id_rsa.pub

なお、catコマンドの後は鍵を作成したファイルを指定します。

次にGitHubのアイコンをクリックし、「Settings」をクリックします。

画面左のメニューバーの中から「SSH and GPG keys」を選択します。

SSH keysの中の「New SSH keys」をクリックします。

「Title」には任意の名前を付け「Key type」は「Authentication Key」を選択します。

そして「Key」に、先ほど作成した公開鍵の文字列を貼り付けてください。

以上でGitHubへの公開鍵のアップロードは完了です。

公開鍵がアップロードできれば、以下のコマンドを実行します。

ssh -T git@github.com

以下のように表示されれば接続完了です。

GitHubで「Create Repository」をクリックしてリモートリポジトリを作成します。

リポジトリの作成画面に移るので、それぞれの項目を入力して「Create repository」をクリックします。

リモートリポジトリの作成が完了すると、以下のような画面に移ります。

次にローカルリポジトリを作成します。

以下のコマンドを実行して、ローカルリポジトリ用のディレクトリを作成します。

なお、ディレクトリ名は任意のもので大丈夫です。

mkdir test

以下のコマンドで作成したディレクトリに移動します。

cd test

移動後、以下のコマンドを実行して作成したディレクトリをローカルリポジトリにします。

git init

以下のように表示されれば、ローカルリポジトリの作成は完了です。

ローカルリポジトリ下でファイルの作成や変更を行った後は、コミットをする必要があります。

今回はtest.txtというファイルを作成し、このファイルをコミットしていきます。

まずは以下のコマンドでリポジトリの変更内容をインデックスへ追加します。

git add test.txt

次に、以下のコマンドを実行することで、変更内容をコミットします。

コメント内容は自由に変更可能です。

git commit -m "コメント"

以下のコマンドを入力すると、コメントを含めた変更履歴を見ることができます。

git log

このように履歴が表示されていればローカルリポジトリへのコミットは完了です。

続いてローカルリポジトリをリモートリポジトリへプッシュします。

まずは以下のコマンドを実行してローカルリポジトリとリモートリポジトリを紐づけましょう。

git remote add origin <リモートリポジトリのURL>

なお、リモートリポジトリのURLは「code」から参照してください。

紐づけが完了した後は、以下のコマンドでプッシュします。

git push origin main

プッシュが完了すると、GitHub上で変更が反映されていることが分かります。

ブランチを作成することで、他のブランチに影響を与えずリポジトリを変更することができます。

特に複数人で同時に作業を行う際に有効です。

ブランチは以下のコマンドで作成できます。

git branch <ブランチ名>

また、以下のコマンドを実行するとブランチの一覧を表示できます。

git branch

以下のコマンドを実行することで作業するブランチを切り替えられます。

git checkout <ブランチ名>

切り替えたブランチでファイルの編集を行い、ブランチ名でリモートリポジトリにプッシュします。

リモートリポジトリを確認すると、「Compare ＆ pull request」というボタンが追加されているので、クリックしましょう。

プルリクエストの画面が開くので、コメントを入力して「Create pull request」をクリックします。

こうすることで、プルリクエストが送信できます。

プルリクエストが送信されると、コードレビューやマージが行えるようになります。

コードレビューは「Files changed」タブから行えます。

コメントしたい行を選択してコメントを書き、「Start a review」をクリックすることで変更箇所に対してコメントができます。

また、「Review changes」をクリックして「Submit review」を押すことでコードレビューを終了できます。

リポジトリの変更内容を適用（マージ）するには、プルリクエストの画面から、「Merge pull request」をクリックします。

コメントを書いて「Confirm merge」をクリックすると、マージが完了します。

まずはリポジトリの「Issues」タブを選択し、「New Issue」をクリックしましょう。

タイトルや説明を記入します。

説明はMarkdown形式で記入することが可能です。

「Create」をクリックすることでIssueを作成できます。

続いてProjectsを作成します。

リポジトリの「Projects」タブを選択し、「New project」をクリックします。

テンプレートが表示されるので、目的に合ったものを選択します。

選択後、プロジェクト名を設定し、「Create project」をクリックするとProjectsが作成できます。

ProjectsにはIssueやプルリクエストを追加することができます。

追加するには、Projects画面下の「+ Add item」をクリックします。

ここにIssueやプルリクエストのURLを貼り付けます。

Enterキーを押すと、IssueやプルリクエストがProjectsに追加されます。

GitHub Actionsの自動化処理は、ワークフローと呼ばれます。

ワークフローは、.github/workflows/ディレクトリにYAML形式のファイルを作成することで定義できます。

ファイルを作成するには、GitHubの「Add file」から「Create new file」をクリックします。

ファイル名でYAMLファイルを指定します。

なお、.github/workflowsディレクトリがない場合は、.github/workflows/sample.ymlと入力することでディレクトリごと作成できます。

ここでは、AIモデルのファインチューニングを行うプロジェクトにおいて、CIパイプラインとしてプルリクエストが作成・変更されたときにスモークテストを実施するワークフローを作成しました。

name: Pull Request CI

on:
  pull_request:
    branches: [ main ]

jobs:
  lint-and-unit-test:
    name: Lint and Unit Test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.10'
      - name: Install dependencies
        run: pip install -r requirements.txt
      - name: Lint with ruff
        run: ruff check .
      - name: Run unit tests
        run: pytest tests/

  smoke-test-finetuning:
    name: Smoke Test Fine-tuning
    needs: lint-and-unit-test # 先のジョブが成功したら実行
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.10'
      - name: Install dependencies
        run: pip install -r requirements.txt
      - name: Run fine-tuning script with small data
        run: |
          # finetune.pyスクリプトを、学習エポック数1、
          # バッチサイズを小さく設定し、
          # テスト用の少量データセット（--smoke-testフラグで指定）で実行
          python src/finetune.py \
            --model_name_or_path "tohoku-nlp/bert-base-japanese-v3" \
            --output_dir "./test-output" \
            --num_train_epochs 1 \
            --per_device_train_batch_size 2 \
            --smoke_test

また、CDパイプラインとして、プルリクエストがmainブランチにマージされた際に本番用の完全なデータセットを使ってモデルのファインチューニングと評価を実行するワークフローも作成しました。

name: Main Branch CD

on:
  push:
    branches: [ main ]

jobs:
  full-finetune-and-evaluate:
    name: Full Fine-tuning, Evaluation, and Save Model
    runs-on: ubuntu-latest # 本格的な学習にはGPUランナー (e.g., [self-hosted, gpu]) を推奨
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.10'

      - name: Install dependencies
        run: pip install -r requirements.txt

      # データセットの準備 (例: DVCやS3からダウンロード)
      # - name: Download full dataset
      #   run: dvc pull

      - name: Run full fine-tuning and evaluation
        id: training
        run: |
          # 本番データでファインチューニングを実行
          # 評価結果は metrics.json に保存される想定
          python src/finetune.py \
            --model_name_or_path "tohoku-nlp/bert-base-japanese-v3" \
            --output_dir "./production-model" \
            --do_train \
            --do_eval
      
      # Git LFSで管理するため、.gitattributesで track しておくことを推奨
      - name: Save fine-tuned model as artifact
        uses: actions/upload-artifact@v4
        with:
          name: finetuned-bert-japanese-v3
          path: |
            ./production-model/
            ./metrics.json

ワークフローの結果を確認するには、GitHubでリポジトリのメインページに移動し、「Actions」タブを選択します。

左のサイドバーでは、表示したいワークフローを選択できます。

また、ログでは各ステップがどのように処理されたかが表示されます。

実行がうまくいかなかった場合は、どこでどのようなエラーが出たのか表示されるため、デバックもしやすくなっています。