git - 如何在不同存储库中的多个解决方案之间共享源代码库？

Question

我有一个公共(public)库，我想在几个解决方案之间共享它，它存储在不同的 github 存储库中。我们将共享库放在单独的 GitHub 存储库中并创建了 nuget 包，可以将其安装在每个所需的项目/解决方案中。缺点是更改库中的代码涉及几个步骤(更改代码、推送到库存储库、创建 nuget 包、安装包)，这很烦人。

我想使用 git subtree 创建包含库项目的子目录，并将其用作我的解决方案中的本地项目，以便轻松更改/测试/调试代码。“主要”解决方案的开发人员将有一个选择 - 将库作为二进制 nuget 包或作为源项目包含在子目录中。

问题:当我尝试 git subtree 时，我发现了一个问题:当独立包含时，csproj 文件具有对位于不同级别的包文件夹的相对引用库解决方案以及包含在主解决方案中时。在 MyLib.sln 中路径是 "..\Packages"，但在 Main.sln 中路径应该是 "..\..\Packages"。
Main GitHub Repository(和 OtherUserOfMyLib GitHub Repository(is))的结构:

Main.sln
LibSubfolder
-----------------| MyLib.sln
-----------------| MyLibSource
--------------------------| myLib.csproj
--------------------------| myLib code
-----------------| (expected Packages from lib solution)
Packages.  (From main solution)

MyLib GitHub Repository 的结构:

MyLib.sln
MyLibSource
--------------| myLib.csproj
--------------| myLib code
Packages.  (From lib solution)

我试过 git subtree 只从 Lib 存储库复制 MyLibSource 子目录(这将允许包文件夹的相对位置相同)。不幸的是，我没有找到从另一个 repo 复制子目录的方法，该方法支持稍后将更改推送回原始 repo。答案 Add subdirectory of remote repo with git-subtree有几个选项，但所有选项似乎都只讨论了单向( pull )同步。从我看来，git submodule 和 git subrepo 不支持从源存储库复制子文件夹。

我错过了什么吗？谁能建议如何从库存储库复制到我的存储库文件夹的子文件夹，这将允许以后双向( pull/推)同步？

我考虑的其他选项是更改包文件夹的位置。但是我不确定，选择哪条路径对于 main.sln 和 MyLib.sln 都是一致的。

第三种方法是不使用 MyLib 存储库中的 MyLib.sln；仅将存储库用作库源代码的主存储。而是在主存储库中创建 MyLib.sln 并使用它来构建 NuGet 包。我将能够使用 git subtree pull/push MyLibSource 项目的内容。 OtherUserOfMyLib 存储库将仅引用子文件夹中的项目，并在需要时调用 git subtree pull/push

Main.sln
MyLib.sln       ( locate in Main repository instead of MyLib repository)
LibSubfolder
-----------------| MyLibSource
--------------------------| myLib.csproj
--------------------------| myLib code
Packages

我的问题是尝试哪种方法:

• 花时间尝试找到一种方法来推回创建的 git 子树子文件夹？
• 尝试更改包文件夹的位置？
• 保留在存储库之外构建 nuget 包的解决方案有包裹(第三种方法)？
• 还有什么事吗？

我看过类似的问题 Best practice to share common libraries between solutions in .NET和 How do you share code between projects/solutions in Visual Studio?但没有找到满意的解决方案。

Answer 1

我能够使用 git subtree 将公共(public)存储库(例如源代码库)共享为不同客户端解决方案(存储库)的子文件夹，并允许将更改推送回共享存储库。

我们对 c# 库、Powershell psm 模块的文件夹使用类似的方法，考虑用于收集 React jsx 组件。对于 c# 库，其中一个客户端存储库构建了 NuGet 包，任何喜欢引用 NuGet 包而不是源代码的解决方案都可以使用它。

如果我们需要包含一些开源 github 库的源代码(例如，如果我们想要在新版本可用之前进行更改)，我们将使用相同的方法。

在每个应用程序存储库中，我们需要自定义两个批处理文件(针对每个公共(public)存储库):subtreePull 和 subtreePush。

批处理文件示例(基于 Add subdirectory of remote repo with git-subtree 答案的选项 4):
MyCommonLib-SubtreePull.cmd

@rem Template Pull and Push  are located in SubTreeCommands folder
@Rem from https://developer.atlassian.com/blog/2015/05/the-power-of-git-subtree
@set remoteBranch=master
@set RelativeTarget=src/MyApplicationProject/LibSource/MyCommonLib
@echo If you have errors "Working tree has modifications.  Cannot add." uncomment stash before command and stash apply after command
@REM git stash 
@rem run this command from the toplevel of the working tree 
@for /f %%i in ('git rev-parse --show-toplevel ') do set GitRoot=%%i
CD %GitRoot%
IF EXIST %RelativeTarget% (
set gitCmd=pull
) ELSE (
set gitCmd=add  
)
@rem if you want to have full history, do not include  --squash
git subtree %gitCmd%  --prefix %RelativeTarget% https://github.com/MyCompany/MyCommonLib.git %remoteBranch% --squash
@REM git stash apply
@pause

MyCommonLib-SubtreePush.cmd

@Rem from https://medium.com/@v/git-subtrees-a-tutorial-6ff568381844#.a2ne9vlve
set remoteBranch=master
@rem run this command from the toplevel of the working tree 
@for /f %%i in ('git rev-parse --show-toplevel ') do set GitRoot=%%i
CD %GitRoot%
git subtree push --prefix=src/MyApplicationProject/LibSource/MyCommonLib https://github.com/MyCompany/MyCommonLib.git  %remoteBranch%
@pause

在工作期间，您正在对应用程序存储库中的更改进行正常的 git 提交/git 推送，包括 LibSource 公共(public)库子文件夹中的更改。

要同步您的公共(public)库更改，请运行 subtreePush/subtreePull 命令。
请注意，建议在库中发生重大更改后运行 subtreePush(例如，在每个相关项目的末尾)。
subtreePull 可能由不同的人在不同的存储库中完成，建议在对存储库进行主要工作之前运行(例如在项目开始时)。
子树 pull 和推送批处理都需要一些时间来运行，但您可以启动它们并执行其他任何操作。