git：如何将库从项目中分离出来？过滤器分支，子树？

Question

所以，我有一个更大的（闭源）项目，并且在这个项目的背景下创建了一个库，我认为它在其他地方也很有用。

我现在想将这个库拆分到自己的项目中，该项目可以在 github 或类似项目上作为开源项目。当然，图书馆（及其历史）不应该包含我们项目的痕迹。

git-subtree 似乎是一个解决方案，但它并不完全适合。

我的目录布局是这样的（因为它是一个 Java 项目）：

• fencing-game (git workdir)
  • 源代码
    • 德
      • 击剑游戏
        • 交通 （我的图书馆）
          • 协议 （库的一部分）
          • 击剑（与库交互的主项目的一部分）
          • 客户端（与库交互的主项目的一部分）
          • 服务器（与库连接的主项目的一部分）
        • 客户端（主项目的一部分）
        • 服务器（主项目的一部分）
        • ...（主项目的一部分）
  • 其他文件和目录（构建系统、网站等 - 主项目的一部分）

拆分后，我希望库的目录布局看起来像这样（包括直接在粗体目录中的任何文件）：

• my-library （名称待定）
  • 源代码
    • 德
      • 击剑游戏
        • 交通 （我的图书馆）
          • 协议 （库的一部分）

历史记录还应该仅包含主项目历史记录中涉及存储库这一部分的部分。< /strong>

乍一看，我看到了 git-subtree split --prefix=src/de/fencing_ame/transport，但这会给

1. 我一棵植根于 transport 的树（其中将不会编译）并
2. 包含transport/client、transport/server 和 transport/fencing 目录。

第一点可以通过在接收端使用 git subtree add --prefix=src/de/fencing_ame/transport来缓解，但我不认为 git-subtree 可以做太多事情反对导出这些子目录。 （这个想法实际上是能够在这里共享完整的树）。

我必须在这里使用 git filter-branch 吗？

拆分后，我希望能够使用 git-subtree 或 git-submodule 在单独的子目录中（而不是现在的位置）导入回主项目中的库。我想象这样的布局

• 击剑游戏(git workdir)
  • 源代码
    • 德
      • 击剑游戏
        • 运输（空）
          • 击剑（与库交互的主项目的一部分）
          • 客户端（与库交互的主项目的一部分）
          • 服务器（与库连接的主项目的一部分）
        • 客户端（主项目的一部分）
        • 服务器（主项目的一部分）
        • ...（主项目的一部分）
  • 我的图书馆
    • 源代码
      • 德
        • 击剑游戏
          • 交通 （我的图书馆）
            • 协议 （库的一部分）
  • 其他文件和目录（构建系统、网站等 - 主项目的一部分）

What would be the most pain-free way to do this? Are there other tools than git-subtree and git-filter-branch for this goal?

Answer 1

我认为你有一些真正的洞穴探险要做。如果你只是想拆分“协议”，你可以使用“git subtree split ...”或“git filter-branch ...”来

实现git filter-branch --subdirectory-filter
fencing-game/src/de/fencing_game/transport/protocol -- --all

但是如果你在传输和传输/协议中都有文件，它就会开始变得毛茸茸的。

我编写了一些自定义工具来为我正在进行的项目执行此操作。它们没有在任何地方发布，但您可以使用 reposurgeon 执行类似的操作。

Answer 2

拆分与父项目中的文件混合的子树

这似乎是一个常见的请求，但是当文件夹混合在一起时，我认为没有一个简单答案那。

我建议将库与其他文件夹混合在一起的一般方法是这样的：

1. 使用库的新根创建一个分支：

   git 子树 split -P src/de/fencing_game -b temp-br
   git checkout temp-br git checkout temp-br
   
   # -或者-，如果你确实想保留完整路径：
   
   git checkout -b 临时-br
   cd src/de/fencing_game
   

2. 然后使用某些东西来重写历史记录以删除不属于库的部分。我不是这方面的专家，但我能够进行实验并发现类似的方法可以工作：

   git filter-branch --tag-name-filter cat --prune-empty --index-filter 'git rm -rf --cached --ignore-unmatch 客户端服务器 otherstuff' HEAD
   
   # 还清除子目录中的内容
   光盘传输 
   git filter-branch --tag-name-filter cat --prune-empty --index-filter 'git rm -rf --cached --ignore-unmatch fencing 客户端服务器' HEAD
   

   注意：您可能需要删除连续命令之间由 filter-branch 所做的备份。

   git update-ref -d refs/original/refs/heads/temp-br
   

3. 最后，只需为库创建一个新的存储库并提取剩下的所有内容：

   cd ;
   git初始化
   git pull ;温度-br
   

我建议您的最终库路径更像 /transport/protocol 而不是完整的父项目路径，因为这似乎与项目相关。

Answer 3

这里的问题是，你的库中的内容和不包含的内容没有很好的区分。我强烈建议重构该解决方案，然后您可以将该库作为子模块包含在内。

如果其他开发人员仅在同一个存储库中重用此库，则只需在单独的分支上跟踪这些更改，而不必担心其他存储库。

Answer 4

项目的历史只是为了你的利益，还是为了github上的人的利益？

如果历史只是为了您的利益，有一个简单的方法使用移植物。基本上，只需为 github 创建一个全新的存储库，删除所有专有代码。现在您拥有了一个仅包含公共代码的开源存储库，您可以将其推送到 github。在开源存储库的本地副本中，您可以将专有存储库中的历史记录移植到开源存储库上。

这样做意味着您（或有权访问专有存储库的任何人）可以看到完整的历史记录，但公众只能看到您开源代码时的代码。

.git/info/grafts 的用途是什么？

Answer 5

我做了类似的事情，但是将几个目录的内容分成加密分区（/ secure / tmp / newrepo）上的一个完全独立的存储库，因此笔记本电脑窃贼无法使用它们。
我编写了 shell 脚本，然后执行了以下操作：
git filter-branch --tree-filter '~/bin/tryit /secure/tmp/newrepo 个人私有' -- 95768021ff00216855868d12556137115b2789610..HEAD
（SHA 避免在任一目录存在之前进行提交）

---

#!/bin/sh
# to be used with  e.g:
# git filter-branch --tree-filter '~/bin/tryit /secure/tmp/newrepo personal private' 
# Don't do it on any repository you can't repeatedly do: 
#   rm -rf foo ; git clone /wherever/is/foo 
# when it breaks
SRC=`pwd`
DEST=$1
shift
MSG=/dev/shm/msg.txt
TAR=/dev/shm/tmp.tar
LIST=/dev/shm/list.txt
LOG=/dev/shm/log
DONE=''

echo $GIT_AUTHOR_DATE >> $LOG
git show --raw $GIT_COMMIT > $MSG 

for A in $* 
do 

if [ -d $A ] 
then 
DONE=${DONE}x
tar -cf $TAR $A 
tar -tf $TAR > ${LIST}
cat ${LIST} >> ${LOG}
rm -rf ${A}
cd ${DEST}
tar -xf $TAR
else
echo $A non-existant >> ${LOG}
fi
cd $SRC
done

if [ -z "${DONE}" ]
then
echo Empty >>$LOG
else
cd ${DEST}
unset GIT_INDEX_FILE
unset GIT_DIR
unset GIT_COMMIT
unset GIT_WORK_TREE
touch foo
git add .
git commit -a -F ${MSG}  >> ${LOG}
fi
exit 0

---

出于您的目的，您可能希望对 tar 有不同的规范（例如 --exclude= ），然后使用 cat ${LIST} | xargs rm 仅删除 tar 中的内容，但我希望正确地做到这一点并不太棘手。

未设置的内容和 exit 0 很重要，因为 filter-branch 将它们设置为您的源存储库（不是您想要的！），并且如果 sh 从脚本中的最后一个命令传递非零退出代码，则会终止。