Udemy 4. 複数プロジェクトのGit管理 #04
2020年06月24日に更新

【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う

今回達成すること

この3つを行います。

  • GitHubに3つのリポジトリを作成
  • 「root」「api」「front」各プロジェクトをpush
  • GitHubでサブモジュールがリンクするよう.gitmodulesを編集

Git04

GitHubのリポジトリ名のルール

リポジトリの名前は任意ですが、運用のしやすさを考え末尾はディレクトリ名と一致させた名前にします。

ローカルディレクトリパス GitHubリポジトリの名前
root <任意の名前>-root
root/api <任意の名前>-api
root/front <任意の名前>-front

ちなみに筆者は、ローカルのプロジェクトとGitHubリポジトリが一目で一致するように、リポジトリ名とディレクトリ名を一致させています。

筆者の場合
ローカルディレクトリパス GitHubリポジトリの名前
udemy_demoapp_v1 udemy-demoapp-v1-root

ここにルールはありませんので、ご自身が運用しやすいような名前を付けてください。

それではGitHubにログインしブラウザ作業に移りましょう。

GitHubに3つのリポジトリを作成する

プロジェクトを保管するリポジトリを作成します。

右上の「+」マークから「New repository」を選択します。

2020-06-20 12-33-29

続いてリポジトリの詳細を入力します。

2020-06-20 12-38-21

  1. Repository name

    リポジトリの名前を入力します。

    保管するプロジェクトパスに合わせて下記のように名付けしましょう。

    • root => 「任意の名前-root」
    • root/api => 「任意の名前-api」
    • root/front => 「任意の名前-front」
  2. Description

    リポジトリの説明です。自分がわかりやすいような説明を。

  3. Public or Private

    Privateをにチェックを入れてください。

    • Public => みんなに公開されます。
    • Private => 自分と自分が許可したユーザーのみ参照できます。
  4. Create repository

    その他のチェックマークなどは後からでも作成できます。

    そのままこのボタンを押してリポジトリを作成しましょう。

この操作を繰り返し、3つのリポジトリを作成しましょう。

完成したリポジトリたち

筆者の場合このようになりました。

2020-06-20 17-00-25

GitHubにプロジェクトを作成する

続いて3つのリポジトリを紐付けるプロジェクトを作成します。

今回は紐付けをすることを目的に作成しますので、プロジェクトの機能自体は利用しません。

ただ便利な機能もあるようなので活用してみても良いでしょう。


それでは右上の「+」アイコンから「New project」へ移動します。

2020-06-20 17-05-57

2020-06-20 17.08.46

  1. Project board name

    プロジェクト名を入力してください。

  2. Visibility

    Private(非公開)を選択してください。

  3. Linked repositories

    リンクするリポジトリを選択します。

    先ほど作成した3つのリポジトリを全て選択してください。

以上の入力が完了したら「Create project」ボタンで作成します。


以上でGitHub上での操作は完了です。

apiディレクトリをpushする

まずは「api」ディレクトリをGitHubにpushします。

ターミナル上から「api」ディレクトリに移動してください。

api $ # ここに移動

1. リモートリポジトリのURLを取得する

最初にリモートリポジトリとローカルのリポジトリを接続しなければなりません。

リモートリポジトリとは、ネットワーク上に存在するリポジトリの事を言い、ここではGitHub上のリポジトリを指します。


接続先のURLを取得しましょう。GitHubにログインしてください。

  • 右上「ユーザーアイコン」から
  • Your profile」を選択します。
  • 続いて、タブ「Repositories」を選択し
  • apiリポジトリ」の中に入りましょう。

2020-06-20 17-00-25

リポジトリの中に入ったら画像の赤枠コマンドをコピーします。

2020-06-20 17-35-54

2. リモートリポジトリのURLを登録する

コピーしたコマンドを「api」ディレクトリ直下で実行しましょう。

api $ git remote add origin https://github.com/<ユーザー名>/<リポジトリ名>.git

確認しましょう。

api $ git remote -v

origin	https://github.com/<ユーザー名>/<リポジトリ名>.git (fetch)
origin	https://github.com/<ユーザー名>/<リポジトリ名>.git (push)

このURLがローカルからpushした時の接続先URLとなります。

3. GitHubにpushする

それではpushしてみましょう。

api $ git push -u origin master
  • -uオプション … 「master」ブランチを「origin」にpush する、と言う意味。

    • origin … リモートリポジトリの接続先を指定している。

      具体的には$ git remote addで追加したoriginのURLを参照している。

    この-uオプションは最初のpushの時だけ付ければOK。

    以後は省略できて、自動でリモートリポジトリに接続される。

    参考 git push -u オプションで”上流ブランチ”を設定 | WWWクリエイターズ


pushできたかGitHubの画面で確認します。

「apiリポジトリ」の画面をリロードしてください。

2020-06-20 18-05-32

成功です。無事「api」ディレクトリがpushさました。

frontディレクトリをpushする

続いて「front」ディレクトリに移動しましょう。

api $ cd ../front

GItHubの「frontリポジトリ」に移動します。

ユーザープロフィール画面に移動して、

2020-06-20 18-11-41

「Repositories」タブから「frontリポジトリ」に入ります。

2020-06-20 18-14-02

入ったら先ほどと同じようにコマンドをコピーして、「front」ディレクトリ直下で実行します。

front $ git remote add origin https://github.com/<ユーザー名>/<リポジトリ名>.git

originのURLが正しく設定できていることを確認してpushしましょう。

front $ git remote -v
front $ git push -u origin master

GitHub上の「frontリポジトリ」をリロードしてpushできたか確認しておきましょう。

rootディレクトリをpushする

最後は「root」ディレクトリの作業です。移動しましょう。

front $ cd ..

手順は同じです。

root $ git remote add origin https://github.com/<ユーザー名>/<リポジトリ名>.git
root $ git remote -v
root $ git push -u origin master

pushができたか必ず確認しておきましょうね。

rootリポジトリにサブモジュールリンクを追加する

今のままでは「rootリポジトリ」の

  • apiリポジトリ
  • frontリポジトリ

にリンクが紐付いていません。

2020-06-20 19-00-30

そこで、「apiリポジトリ」と「frontリポジトリ」にリンクされるよう.gitmodulesを編集します。

エディタに移動しましょう。

.gitmodules
[submodule "api"]
  path = api
  url = https://github.com/<ユーザー名>/<apiリポジトリのパス>
[submodule "front"]
  path = front
  url = https://github.com/<ユーザー名>/<frontリポジトリのパス>

ここのurlは、各リポジトリを開いた時のURLを指定します。

2020-06-22 09-10-24

編集できたら「root」ディレクトリを再度pushします。

root $ git commit -am "add_submodule_link"
root $ git push

GitHubの「rootリポジトリ」をリロードして確認してみましょう。

2020-06-20 19-13-25

OK。無事リンクがつきました。

サブモジュールのバージョン管理

上の画像の@以下に表示されている番号は、サブモジュールのコミットIDです。

「api」ディレクトリに移動して確認してみましょう。

root $ cd api
api  $ git log

commit c2a973659bb3b1b6698ae071d6e55486c9e58293 (HEAD -> master, origin/master)
...

表示されるcommit c2a9736...と一致しています。

「rootリポジトリ」は、このコミットIDによりサブモジュールのバージョンを管理しています。

rootリポジトリをpushするタイミング

「apiリポジトリ」と「frontリポジトリ」を新たにコミットした時はコミットIDが変化します。

その場合「rootリポジトリもpushする必要があります。

  1. 「api」ディレクトリ内のRailsアプリを編集

  2. 「apiリポジトリ」にpush

  3. 「apiリポジトリ」のコミットIDが変化

  4. 「rootリポジトリ」もpush

まとめ

今回はGitHubに3つのリポジトリを作成し、ローカルのプロジェクトをそれぞれのリポジトリにpushしました。

サブモジュールの設定も行い、より快適にGitHubを使えるようになりました。めでたし。

このチャプターのまとめ

以上で「複数プロジェクトのGit管理」のチャプターを終了します。

最後に何をやったかをまとめておきますね。

次回は?

次回より新チャプター「Rails × Nuxt.js初めてのAPI通信」が始まります。

やっとコードらしいコードが書けますね。

どうぞお楽しみに。

(↓のリストからお進みください。)

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】このカテゴリーで作るアプリケーションの仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
最初の一歩。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
新着
SPA開発
ブログ構築
小ネタ集