如何让团队使用含私有仓库单文件的公共GitHub项目？

方案1：Git子模块+稀疏检出（针对单个/少量文件场景） #

这种方式可以只拉取私有仓库中你需要的那个文件，而非整个仓库，同时保持文件的版本同步：

1. 在公共项目的根目录下，添加私有仓库作为子模块：

   git submodule add <你的私有仓库URL> ./SharedFiles
   

2. 进入子模块目录，配置稀疏检出，只包含目标文件所在的路径：

   cd SharedFiles
   git config core.sparseCheckout true
   echo "path/to/your/shared/file.cs" >> .git/info/sparse-checkout
   git pull
   

3. 回到公共项目，修改原文件链接的路径，指向子模块目录下的目标文件。
4. 提交子模块配置到公共仓库，团队成员拉取代码时，执行以下命令获取子模块内容：

   git submodule init
   git submodule update
   

   注意：团队成员需要拥有你的私有仓库的访问权限（比如GitHub的SSH密钥或个人令牌）。

方案2：轻量级私有NuGet包（适合版本管理+无需直接访问私有仓库） #

如果不想让团队成员直接接触私有仓库，可以把单个共享文件打包成极简NuGet包：

1. 创建一个新的极简类库项目，只添加那个共享文件，仅引入公共项目实际需要的NuGet依赖（不要多余引用）。
2. 配置项目文件（.csproj），确保打包时只包含必要内容：

   <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
       <TargetFramework>net6.0</TargetFramework>
       <PackageId>Your.Shared.File.Package</PackageId>
       <Version>1.0.0</Version>
       <Authors>Your Name</Authors>
       <Description>Single shared file package</Description>
     </PropertyGroup>
     <ItemGroup>
       <Compile Include="YourSharedFile.cs" />
     </ItemGroup>
   </Project>
   

3. 打包NuGet包：

   dotnet pack
   

4. 将包上传到私有NuGet源（比如GitHub Packages、Azure Artifacts），然后让团队成员配置这个私有源。
5. 公共项目直接通过NuGet安装这个轻量包，不会引入多余依赖，且能通过版本号管理文件更新。

方案3：Visual Studio共享项目（适合多文件共享+直接编译入主项目） #

如果后续可能有更多共享文件，共享项目是更灵活的选择：

1. 在你的私有仓库中，将共享文件迁移到一个**共享项目（Shared Project）**中（Visual Studio新建项目时选择"共享项目"模板）。
2. 把这个共享项目作为子模块引入到公共解决方案中，和方案1的子模块添加方式一致。
3. 在公共项目中添加对该共享项目的引用，共享项目的代码会直接编译到公共项目的程序集里，不会生成额外DLL，也不会强制引入多余的NuGet依赖（公共项目只需要添加自己用到的依赖即可）。
4. 团队成员拉取子模块后，就能正常使用共享项目中的代码，修改也能同步。

方案对比 #

• 子模块+稀疏检出：适合单个文件，操作简单，无需额外项目，但成员需要私有仓库权限。
• 轻量级NuGet包：无需成员访问私有仓库，版本管理方便，适合对外分发共享代码。
• 共享项目：适合多文件共享，代码直接编译入主项目，无额外DLL开销，适合团队内部协作。

内容的提问来源于stack exchange，提问作者Martin Weiß