git submodule を含むリポジトリで mirror を作る方法

クラウド上など、Git リポジトリがインターネット上にある場合、大きなリポジトリを扱うときには clone するのに時間がかかるので ローカルネットワークにミラーサーバーを作ることで転送にかかる時間を節約することができます。

その際、git submodule を含むリポジトリの場合注意が必要なので具体例を踏まえながら運用を説明します

ポイントは submodule は絶対パス以外に相対パスも使えるということです。 これでピンとくる人は後は読まなくてもいいいです。

前提知識

サンプルの構成

• 親リポジトリ (GitHub: submod-parent)
• Submodule 1 (GitHub: submod1)
• Submodule 2 (GitHub: submod2)

• 親リポジトリ (Bitbucket: submod-parent) (ミラー先)
• Submodule 1 (Bitbucket: submod1) (ミラー先)
• Submodule 2 (Bitbucket: submod2) (ミラー先)

準備

• submod-parent
• submod1
• submod2

• submod-parent
• submod1
• submod2

大まかな流れ

GitHub (ミラー元) の構築

1. submod1
   1. git clone
   2. ファイル編集
   3. git add
   4. git commit
   5. git push
2. submod2
   1. git clone
   2. ファイル編集
   3. git add
   4. git commit
   5. git push
3. submod-parent
   1. git clone
   2. ファイル編集
   3. git add
   4. git commit
   5. submod1 を submodule として追加
   6. submod2 を submodule として追加
   7. git commit
   8. git push

Bitbucket (ミラー先) の構築

1. submod1
   1. git remote add
   2. git push
2. submod2
   1. git remote add
   2. git push
3. submod-parent
   1. git remote add
   2. git push

Bitbucket (ミラー先) の clone

1. git clone
2. git submodule init
3. git submodule update

GitHub 上のリポジトリへのコード登録

GitHub 上に submodule 用のリポジトリ1 を登録する

submod1 のリポジトリを clone

D:\demo>git clone https://github.com/m-tmatma/submod1.git
Cloning into 'submod1'...
warning: You appear to have cloned an empty repository.

submod1 のリポジトリにコードを commit

D:\demo>cd submod1

D:\demo\submod1>echo test1 > test1.txt

D:\demo\submod1>git add test1.txt

D:\demo\submod1>git commit -m "add test1.txt"
[master (root-commit) fef6a0b] add test1.txt
 1 file changed, 1 insertion(+)
 create mode 100644 test1.txt

submod1 のリポジトリにコードを push

D:\demo\submod1>git push origin master
Enumerating objects: 3, done.
Counting objects: 100% (3/3), done.
Writing objects: 100% (3/3), 228 bytes | 228.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
To https://github.com/m-tmatma/submod1.git
 * [new branch]      master -> master

GitHub 上に submodule 用のリポジトリ2 を登録する

submod2 のリポジトリを clone

D:\demo>git clone https://github.com/m-tmatma/submod2.git
Cloning into 'submod2'...
warning: You appear to have cloned an empty repository.

submod2 のリポジトリにコードを commit

D:\demo>cd submod2

D:\demo\submod2>echo test2 > test2.txt

D:\demo\submod2>git add test2.txt

D:\demo\submod2>git commit -m "add test2.txt"
[master (root-commit) 5bb30aa] add test2.txt
 1 file changed, 1 insertion(+)
 create mode 100644 test2.txt

submod2 のリポジトリにコードを push

D:\demo\submod2>git push origin master
Enumerating objects: 3, done.
Counting objects: 100% (3/3), done.
Writing objects: 100% (3/3), 226 bytes | 226.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
To https://github.com/m-tmatma/submod2.git
 * [new branch]      master -> master

GitHub 上に 親リポジトリを登録する

submod-parent のリポジトリを clone

D:\demo>git clone https://github.com/m-tmatma/submod-parent.git
Cloning into 'submod-parent'...
warning: You appear to have cloned an empty repository.

submod-parent のリポジトリにコードを commit

D:\demo>cd submod-parent

D:\demo\submod-parent>echo test-parent > test-parent.txt

D:\demo\submod-parent>git add test-parent.txt

D:\demo\submod-parent>git commit -m "add test-parent.txt"
[master (root-commit) 3728826] add test-parent.txt
 1 file changed, 1 insertion(+)
 create mode 100644 test-parent.txt

submod-parent のリポジトリに submodule を追加

D:\demo\submod-parent>git submodule add ../submod1 submod1
Cloning into 'D:/demo/submod-parent/submod1'...
remote: Enumerating objects: 3, done.
remote: Counting objects: 100% (3/3), done.
remote: Total 3 (delta 0), reused 3 (delta 0), pack-reused 0
Unpacking objects: 100% (3/3), done.
warning: LF will be replaced by CRLF in .gitmodules.
The file will have its original line endings in your working directory

D:\demo\submod-parent>git submodule add ../submod2 submod2
Cloning into 'D:/demo/submod-parent/submod2'...
remote: Enumerating objects: 3, done.
remote: Counting objects: 100% (3/3), done.
remote: Total 3 (delta 0), reused 3 (delta 0), pack-reused 0
Unpacking objects: 100% (3/3), done.
warning: LF will be replaced by CRLF in .gitmodules.
The file will have its original line endings in your working directory

ローカルの状態確認

D:\demo\submod-parent>git status
On branch master
Your branch is based on 'origin/master', but the upstream is gone.
  (use "git branch --unset-upstream" to fixup)

Changes to be committed:
  (use "git reset HEAD ..." to unstage)

        new file:   .gitmodules
        new file:   submod1
        new file:   submod2

submod-parent のリポジトリに submodule の追加を commit

D:\demo\submod-parent>git commit -m "add submodule"
[master e60d89e] add submodule
 3 files changed, 8 insertions(+)
 create mode 100644 .gitmodules
 create mode 160000 submod1
 create mode 160000 submod2

submod-parent のリポジトリにコードを push

D:\demo\submod-parent>git push origin master
Enumerating objects: 6, done.
Counting objects: 100% (6/6), done.
Delta compression using up to 16 threads
Compressing objects: 100% (4/4), done.
Writing objects: 100% (6/6), 614 bytes | 614.00 KiB/s, done.
Total 6 (delta 0), reused 0 (delta 0)
To https://github.com/m-tmatma/submod-parent.git
 * [new branch]      master -> master

Bitbucket 上のリポジトリへのコード登録

Bitbucket 上に submodule 用のリポジトリ1 を登録する

Bitbucket の submod1 を remote URL として登録

D:\demo\submod1>git remote -v
origin  https://github.com/m-tmatma/submod1.git (fetch)
origin  https://github.com/m-tmatma/submod1.git (push)

D:\demo\submod1>git remote add mirror https://bitbucket.org/m-tmatma/submod1.git

remote の登録確認

D:\demo\submod1>git remote -v
mirror  https://bitbucket.org/m-tmatma/submod1.git (fetch)
mirror  https://bitbucket.org/m-tmatma/submod1.git (push)
origin  https://github.com/m-tmatma/submod1.git (fetch)
origin  https://github.com/m-tmatma/submod1.git (push)

Bitbucket の submod1 に push

D:\demo\submod1>git push mirror master
Enumerating objects: 3, done.
Counting objects: 100% (3/3), done.
Writing objects: 100% (3/3), 228 bytes | 228.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
To https://bitbucket.org/m-tmatma/submod1.git
 * [new branch]      master -> master

Bitbucket 上に submodule 用のリポジトリ2 を登録する

Bitbucket の submod2 を remote URL として登録

D:\demo\submod2>git remote -v
origin  https://github.com/m-tmatma/submod2.git (fetch)
origin  https://github.com/m-tmatma/submod2.git (push)

D:\demo\submod2>git remote add mirror https://bitbucket.org/m-tmatma/submod2.git

remote の登録確認

D:\demo\submod2>git remote -v
mirror  https://bitbucket.org/m-tmatma/submod2.git (fetch)
mirror  https://bitbucket.org/m-tmatma/submod2.git (push)
origin  https://github.com/m-tmatma/submod2.git (fetch)
origin  https://github.com/m-tmatma/submod2.git (push)

Bitbucket の submod2 に push

D:\demo\submod2>git push mirror master
Enumerating objects: 3, done.
Counting objects: 100% (3/3), done.
Writing objects: 100% (3/3), 226 bytes | 226.00 KiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
To https://bitbucket.org/m-tmatma/submod2.git
 * [new branch]      master -> master

Bitbucket 上に 親リポジトリを登録する

Bitbucket の submod-parent を remote URL として登録

D:\demo\submod-parent>git remote -v
origin  https://github.com/m-tmatma/submod-parent.git (fetch)
origin  https://github.com/m-tmatma/submod-parent.git (push)

D:\demo\submod-parent>git remote add mirror https://bitbucket.org/m-tmatma/submod-parent.git

remote の登録確認

D:\demo\submod-parent>git remote -v
mirror  https://bitbucket.org/m-tmatma/submod-parent.git (fetch)
mirror  https://bitbucket.org/m-tmatma/submod-parent.git (push)
origin  https://github.com/m-tmatma/submod-parent.git (fetch)
origin  https://github.com/m-tmatma/submod-parent.git (push)

Bitbucket の submod-parent に push

D:\demo\submod-parent>git push mirror master
Enumerating objects: 6, done.
Counting objects: 100% (6/6), done.
Delta compression using up to 16 threads
Compressing objects: 100% (4/4), done.
Writing objects: 100% (6/6), 614 bytes | 614.00 KiB/s, done.
Total 6 (delta 0), reused 0 (delta 0)
To https://bitbucket.org/m-tmatma/submod-parent.git
 * [new branch]      master -> master

Bitbucket 上のミラーを clone

clone

D:\demo>git clone https://bitbucket.org/m-tmatma/submod-parent.git mirror
Cloning into 'mirror'...
remote: Counting objects: 6, done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 6 (delta 0), reused 0 (delta 0)
Unpacking objects: 100% (6/6), done.

submodule の取得

D:\demo>cd mirror

D:\demo\mirror>git remote -v
origin  https://bitbucket.org/m-tmatma/submod-parent.git (fetch)
origin  https://bitbucket.org/m-tmatma/submod-parent.git (push)

D:\demo\mirror>git submodule init
Submodule 'submod1' (https://bitbucket.org/m-tmatma/submod1) registered for path 'submod1'
Submodule 'submod2' (https://bitbucket.org/m-tmatma/submod2) registered for path 'submod2'

D:\demo\mirror>git submodule update
Cloning into 'D:/demo/mirror/submod1'...
Cloning into 'D:/demo/mirror/submod2'...
Submodule path 'submod1': checked out 'fef6a0b0567400d56de933c6124de6c7a3fb2edb'
Submodule path 'submod2': checked out '5bb30aae61a7a2b729639ed0b16167adafb9cd37'