Zenn
🌳

Gitリポジトリ内にGitリポジトリを配置しようとしたら警告が！？その原因と対処法

2024/06/25に公開
Git
error
troubleshooting
repository
tech

はじめに

Gitで管理しているリポジトリ内に、別のGitリポジトリを配置しようとしたら、予想外の警告メッセージが。

今回は、この問題の原因と対処法について、自分なりに調べてみたことを共有。

問題の状況

まず、どんな状況だったのか説明します。

  1. mainというGitリポジトリが存在（普通に管理してるやつ。リモートリポジトリあり）
  2. subという別のGitリポジトリが存在（これまでローカルだけで管理してた。リモートリポジトリ無し）
  3. subをmainの中に配置しようと作業
  4. commitしようとしたら、警告メッセージが！

警告メッセージの内容

警告メッセージはこんな感じでした：

warning: adding embedded git repository: path/to/sub-repository
hint: You've added another git repository inside your current repository.
hint: Clones of the outer repository will not contain the contents of
hint: the embedded repository and will not know how to obtain it.
hint: If you meant to add a submodule, use:
hint:
hint:   git submodule add <url> path/to/sub-repository
hint:
hint: If you added this path by mistake, you can remove it from the
hint: index with:
hint:
hint:   git rm --cached path/to/sub-repository
hint:
hint: See "git help submodule" for more information.

要するに「リポジトリの中にリポジトリを入れようとしてるよ？それって大丈夫？」って感じですね。

問題の原因

この警告が出る原因は、実はシンプルです。

Gitは通常、1つのリポジトリの中に別のリポジトリを「入れ子」にすることを想定していません。だから、そんなことをしようとすると「ちょっと待って！」って言ってくるわけです。

図で表すとこんな感じ。

main repositoryの中に.gitディレクトリを持つsub repositoryがあるのが問題なんです。

対処法

じゃあ、どうすればいいの？という話ですが、いくつか方法があります。

  1. サブモジュールとして追加する
  2. 内部リポジトリの.gitディレクトリを削除する
  3. 内部リポジトリの内容をメインリポジトリにマージする

今回はエラーメッセージのヒントにも似たようなのがある、2番目の方法を採用。やり方はこんな感じ。

  1. まず、内部リポジトリの.gitディレクトリを削除します：

    rm -rf trunk/SRC/NT24_I3_Src_EC2/.git

  2. 次に、変更をステージングエリアに追加します。

    git add trunk/SRC/NT24_I3_Src_EC2

  3. そして、変更をコミットします：

    git commit -m "Add sub repository to main repository"

これで、警告なしにコミットできるはずです！

注意点

ただし、この方法だと内部リポジトリのGit履歴が失われちゃいます。もし履歴を残しておきたい場合は、別の方法を考えないといけません。

まとめ

今回は、Gitリポジトリの中に別のGitリポジトリを配置しようとしたときに起こる問題とその対処法について説明しました。

みなさんも似たような経験があれば、コメントで教えてください！

GitHubで編集を提案

Discussion