全面掌握Directory.Build.props

为什么需要集中管理版本号?

1)同一个产品包含多个模块,对同一个包指定了不同的版本

比如A模块用了"Serilog.Sinks.Async"的"1.1.2"版本,

B模块用了"Serilog.Sinks.Async"的"1.5.0"版本,

最终集成在C项目里,就会有版本不一致的问题。大多数情况下,这个无所谓。

2)团队在使用自动集成,但是没有集中管理版本号。

如果最终的C项目,是用于部署应用程序的。这个项目的代码,很少需要改动,只是用于发布而已。

当上游的项目,重新编译并推送了新的包到NuGet仓库。

而C项目并没有在Visual Studio打开,更新整个解决方案的NuGet包。

那么Gitlab里,这个C项目的包的定义就还是旧的。

C项目在docker build、docker push和docker run之后,就还可能在使用项目A和项目B的旧的包。

Directory.Build.props的特点

这是dotnet内置的技术,原理很简单。就是dotnet restore的时候,从当前目录下开始寻找Directory.Build.props。

当前目录没有,就去上级目录里找。

直到找到一个Directory.Build.props,就不再向上寻找了。

也就是说,Directory.Build.props和NuGet.Config的机制不一样。

那么 Directory.Build.props有两个特点:

1、Directory.Build.props的定义是不能继承,也不能映像子目录的。

2、和*.csproj文件一样,可以Import其它的文件

如何共享Directory.Build.props及其Import的文件呢?

1、设立分发文件的http网站

用宝塔设立分发Directory.Build.props及其Import文件的网站

2、Windows开发环境的共享

Windows开发环境如何启用Directory.Build.props版本号集中管理

3、在Gitlab Runner里,dotnet build的时候,获取文件

Gitlab中的打包作业完成后,更新http服务器里的版本号文件

这篇文章里,就是这一句话在起作用:

build-job:       # This job runs in the build stage, which runs first.
  stage: build
  before_script:
    - bash $DOWNLOAD_ALL_DIRECTORY_BUILD_PROPS_FILES $DIRECTORY_BUILD_DIST_SERVER_DIRECTORYNAME

$DOWNLOAD_ALL_DIRECTORY_BUILD_PROPS_FILES 这个脚本哪里找?在这篇文章里:

制作docker方式执行Gitlab Runner所需要的镜像

4、在Gitlab Runner里,dotnet pack成功之后,把最新版本号写入分发文件的网站

Gitlab中的打包作业完成后,更新http服务器里的版本号文件

这篇文章里,调用这一段脚本,就可以了:

更新版本号:   # This job runs in the test stage.
  stage: update-version    # It only starts when the job in the build stage completes successfully.
  script:
    - echo "SSH到http服务器,更新文件里的版本号......"
    - bash $DIRECTORY_BUILD_UPDATE_VERSION_SH $DIRECTORY_BUILD_DIST_SERVER_USER $DIRECTORY_BUILD_DIST_SERVER $DIRECTORY_BUILD_DIST_SERVER_DIRECTORYNAME "Directory.Build.Change.EasyComment.props" $EASY_COMMENT_VERSION_ID

$DIRECTORY_BUILD_UPDATE_VERSION_SH 这个脚本哪里找?在这篇文章里:

制作docker方式执行Gitlab Runner所需要的镜像

5、在Gitlab Runner里,docker build的时候,获取最新文件

用Docker发布网站时,自动下载Directory.Build.props及其Import的文件

在Visual Studio生成的Dockerfile里,把

FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build

修改成这样即可:

FROM docker.amicap.cn/amihome/dotnet/sdk8:2024 AS build

WORKDIR /
# 因为要运行下边这个shell,所以build镜像不能用默认的mcr.microsoft.com/dotnet/sdk:8.0
# 我们自己的镜像是包含下边这个shell的
RUN /home/public/download-directory-builds-props.sh dev.amihome.cn

这里用到的docker.amicap.cn/amihome/dotnet/sdk8:2024,根据这篇文章来制作:

适配http分发Directory.Build.props文件,需要替换默认的微软sdk:8.0映像