Skip to content

Latest commit

 

History

History
516 lines (335 loc) · 18.8 KB

README.md

File metadata and controls

516 lines (335 loc) · 18.8 KB
Raw

DotNETBuild

提供dotnet打包方法

Github issues Github forks Github stars Top language Github license

Build NuGet

每个工具之间没有任何依赖，每个工具都同时输出到控制台和写入到 build.coin 配置文件

使用方法

每次构建推荐先调用 dotnet buildkit init 命令，此命令将会做初始化以及必备命令安装，读取机器配置和项目配置写入到构建时配置

后续根据需要调用对应的命令执行构建命令

为什么要创建这个项目

原本团队内部有一个自动构建平台，但是这个平台设计的时候，多个不同的任务之间是通过内存的属性关联的。换句话说是多个不同的任务是不能拿出来单独执行的，必须放在自动构建这个应用程序里面才能跑起来

这带来的问题就是每次有新需求扩展都需要改这个自动构建平台项目

此项目让多个不同的任务放在不同的进程里面，调用的是不同的应用，多个应用之间通过构建时配置文件 build.coin 进行关联，此时方便小伙伴定制和添加自己的构建命令

原则

本项目仅提供一系列的工具，如果某个工具不符合你的需求，或者你的需求没有工具实现。那么请你自行实现，如果说自己实现要做的东西太多了，没关系，边边角角的内容就用我的工具，核心的功能你自己写去。如果写的通用，欢迎发布

本项目原则上减少自己造轮子，尽可能复用现有的工具，通过命令行包装一层的方法，可以快速将大量的工具集成

配置文件等级

放在 AppData\Roaming\dotnet campus\BuildKit\configuration.coin 的文件为机器级配置

放在 项目\build\build.coin 是项目配置

默认在 dotnet buildkit init 命令，将会构建 项目\build.coin 构建时配置文件，此配置将包含机器配置和项目配置，其中项目配置内容相同项将会覆盖机器配置

配置列表

DotNETToolList

需要安装的工具列表，多个工具之间使用分号分割

DotNETToolList
dotnetCampus.UpdateAllDotNetTools;dotnetCampus.UpdateAllDotNetTools

此配置项用来解决某些内部项目需要用到一些内部工具，这部分内部工具不适合开源，但是又期望在 dotnet buildkit init 的时候自动安装

AppVersion

应用的版本，将会在 GetAssemblyVersionTask 读取时写入

更多工具

另一个比较完善的构建辅助项目 nuke-build/nuke: The AKEless Build System for C#/.NET

dotnet/source-build: A repository to track efforts to produce a source tarball of the .NET Core SDK and all its components

工具列表

dotnetCampus.BuildKitTool

这是主工具

dotnet tool install -g dotnetCampus.BuildKitTool

使用方法：

dotnet buildkit init [-c debug|release ]

-c --Configuration 可选 表示当前输出等级是 debug 或 release 等级，以及当前默认构建等级。默认是 Debug 等级

执行此命令将会初始化构建环境，包括寻找各个文件路径，以及安装更新必要工具

PickTextValueTask

从一个文件用正则读取内容，将读取到的内容写入到另一个文件的正则匹配项

dotnet tool install -g dotnetCampus.PickTextValueTask

使用方法

PickTextValueTask -f 输入文件路径 -r 输入文件读取的正则 -o 输出文件路径 -s 输出文件替换的正则

  -f, --InputFile       Required.

  -r, --InputRegex      Required.

  -o, --OutputFile      Required.

  -s, --ReplaceRegex    Required.

此工具将会使用 InputRegex 去读取 InputFile 的内容，找到第一项匹配 match.Groups[1].Value 作为输入的值

然后通过 ReplaceRegex 去读取 OutputFile 的内容，将第一项匹配替换为输入的值，然后再写回 OutputFile 文件

            var inputFilePath = "input file.txt";
            var outputFilePath = "output file.txt";

            var inputText = "<AppVersion>1.2.5-adsfasd</AppVersion>";
            var outputText = "<git-hash>githash</git-hash>";

            var inputRegex = @"\d+\.\d+\.\d+-([\w\d]+)";
            var replaceRegex = @"(githash)";

            File.WriteAllText(inputFilePath, inputText);
            File.WriteAllText(outputFilePath, outputText);

            PickTextValueTask.Program.Main(new[]
            {
                "-f",
                inputFilePath,
                "-r",
                inputRegex,
                "-o",
                outputFilePath,
                "-s",
                replaceRegex
            });

            var replacedText = File.ReadAllText(outputFilePath);
            Assert.AreEqual("<git-hash>adsfasd</git-hash>", replacedText);

MatrixRun

矩阵命令执行工具

dotnet tool install -g dotnetCampus.MatrixRun

image

MatrixRun -m:S1=[A,B,C];S2=[1,2];S3=[x,y,z] -c "echo echo Matrix.S1=%Matrix.S1%, Matrix.S2=%Matrix.S2%, Matrix.S3=%Matrix.S3%"

通过 -m 传入矩阵，可以通过在批处理中使用 Matrix.Xx 环境变量获取运行时的值

使用 -c 传入执行命令，支持批处理文件

矩阵格式是 属性名=可选参数 需要将可选参数放在 [] 内，多个不同的参数使用 , 分割。多个不同的属性使用 ; 分割。而 -c 后的命令，将会取决于矩阵的全排列次数被调用相应的次数

GitRevisionTask

获取当前 Git 的 commit 次数以及 hash 的值，用于创建版本号等

dotnet tool install -g dotnetCampus.GitRevisionTask

用法

GitRevisionTask

将会通过控制台输出当前的 Git 的 commit 次数，同时写入到配置文件的 GitCount 和 CurrentCommit 属性

> 当前的 commit 是这个分支的第几次
GitCount
623
> 当前的 commit 的 hash 的值
CurrentCommit
9a1be330450b10b51230a17390b5cf1a7f8af1d8

SendEmailTask

发送邮件

dotnet tool install -g dotnetCampus.SendEmailTask

用法

SendEmail 参数

必选参数如下

  • -t 或 --To 接收方的邮件地址使用 ; 分割多个不同的命令
  • -s 或 --Subject 邮件标题
  • -b 或 --Body 邮件内容，将 \\r\\n 替换为换行

可选参数如下

  • --SmtpServer 邮件服务器地址，对应配置文件 Email.SmtpServer 内容
  • --SmtpServerPort 邮件服务器端口，对应配置文件 Email.SmtpServerPort 内容
  • --UserName 发送邮件的登录用户名，对应配置文件 Email.UserName 内容
  • --Password 发送邮件的登录密码，对应配置文件 Email.Password 内容
  • --SenderDisplayName 发送邮件显示的发送者名字，对应配置文件 Email.SenderDisplayName 内容，默认和 Email.UserName 相同
  • --Files 附加的文件列表，多个文件使用 | 分割，如 C:\lindexi.txt|C:\doubi.txt 表示两个文件，可使用相对或绝对路径

例子

SendEmail -t [email protected] --subject 测试 --SmtpServer smtp.yandex.com --SmtpServerPort 587 --UserName [email protected] --Password miBN8dFLxdUs9d3

在 GitHub Action 中，可以将用户名密码等存放在凭据管理器里面，详细请看 Creating and storing encrypted secrets - GitHub Docs

另外在统一配置下，推荐统一邮箱账号密码存放到机器级配置里，更多关于机器级配置请看上文

BuildMd5Task

将对输入的文件或文件夹创建 md5 校验文件，传入文件夹时，将会创建每个文件的校验到相同的输出文件

dotnet tool install -g dotnetCampus.BuildMd5Task

用法

BuildMd5 [参数]

如不添加参数，将对当前工作路径的文件夹创建校验文件，将校验文件存放在当前文件夹的 ChecksumMd5.txt 文件

可选参数

- `-p` 或 `--path` 需要用来创建校验的文件夹或文件，默认将会使用当前工作路径文件夹
- `-o` 或 `--output` 输出的校验文件，默认将会输出为当前工作路径的 ChecksumMd5.txt 文件
- `--search-pattern` 匹配文件夹里所有符合此通配符的文件名的文件，多个通配符使用 `|` 字符分割，如同时匹配 exe 和 dll 文件可以使用 `--search-pattern "*.dll|*.exe"` 这句命令。此属性仅在 Path 为文件夹时使用，默认不填将匹配所有文件
- `--ignore-list` 忽略文件列表，暂不支持通配符，需要使用相对路径，路径相对于 Path 路径。多个相对路径使用 `|` 字符分割，此属性仅在 Path 为文件夹时使用。如忽略 `file\lindexi.exe` 文件可以使用 `--ignore-list "file\lindexi.exe"` 这句命令
- `--overwrite [true|false]` 如果校验文件存在，那么将会被覆盖重写。默认值是 false 也就是说校验文件存在将会失败

RunWithConfigValueTask

提供命令自动从配置获取替换符的任务方法，通过此命令行工具执行的命令，将会在执行命令时，将命令行传入的内容自动替换为配置文件里面的对应配置。同时支持在配置不存在时使用默认值的方式

安装方法如下

dotnet tool install -g dotnetCampus.RunWithConfigValueTask

使用方法如下，假定配置文件里面已存在配置是 Foo=doubi 而调用命令行方式如下

RunWithConfigValueTask dotnetcampus.exe f1 $(Foo) $(F2)??lindexi

那么实际执行命令行将会是如下

dotnetcampus.exe f1 doubi lindexi

在传入 RunWithConfigValueTask 的命令，使用格式为 $(配置的Key值) 或者 $(配置的Key值)??默认值 的方式，即可在 RunWithConfigValueTask 替换为配置中对应的参数

RegexReplaceTask

使用正则表达式替换文件内容的工具。可以将文件的内容，用正则表达式替换为输入的指定字符串

安装方法如下

dotnet tool install -g dotnetCampus.RegexReplaceTask

使用方法如下

RegexReplaceTask -v "替换为的字符串" -r "正则表达式" -f "Foo.cs"

参数含义如下

  • -v 将替换为的内容
  • -r 用于替换的正则表达式，其中 match.Groups[1].Value 将被替换为 -v 的参数值。格式如 \d+\.(\d+) 的正则，要求包含一个括号，括号内的匹配内容将会被替换
  • -f 替换内容的文件，要求文件一定存在

可以配合 RunWithConfigValueTask 工具使用，达到读取配置文件的内容，使用此内容用正则替换文件内容。如读取配置文件的由 GitRevisionTask 写入的 $(GitCount) 数据，写入替换到 AssemblyInfo.cs 里面的 $GitRevisionNumber$ 字符串内容，可用如下代码

RunWithConfigValueTask RegexReplaceTask -v $(GitCount) -r "(\$GitRevisionNumber\$)" -f "AssemblyInfo.cs"

替换前的 AssemblyInfo.cs 文件内容如下

[assembly: AssemblyFileVersion("2.2.0.$GitRevisionNumber$")]

假设 $(GitCount) 的值为 123 那么替换后的 AssemblyInfo.cs 文件内容如下

[assembly: AssemblyFileVersion("2.2.0.123")]

PublishFolderCleaner

让 .NET Core 或 .NET 5 或更高版本的 .NET 发布文件夹更简洁工具，将原本杂乱放在发布文件夹下的文件都放入到 lib 文件夹下，让发布文件夹只包含一个 exe 和一个 lib 文件夹

使用方法是在入口程序集安装如下 NuGet 包

  <ItemGroup>
    <PackageReference Include="dotnetCampus.PublishFolderCleaner" Version="1.0.12" />
  </ItemGroup>

此工具仅支持发布 Windows 上的应用

GitLabMergeRequestCreator

用于辅助创建 GitLab 上的 MergeRequest 任务

功能：如果 SourceBranch 与 TargetBranch 相同，那么啥都不做。否则创建 MergeRequest 任务

安装方法如下

dotnet tool install -g dotnetCampus.GitLabMergeRequestCreator

使用方法如下

CreateGitLabMergeRequest -GitLab https://gitlab.sdlsj.net -Token sL5nY_aSNsY2FN9HYjuB -TargetBranch dev -ProjectId 99 -Title "Merge release to dev"

参数描述如下

  • -GitLab: GitLab 地址，如 https://gitlab.sdlsj.net 。可选，默认将通过环境变量获取 GitLab 的 $CI_SERVER_URL 变量
  • -Token: 拥有创建 MergeRequest 的 Token 值，可在 GitLab 上的 profile/personal_access_tokens 生成。可选，默认将通过环境变量获取 GitLab 的 Token 变量。此变量需要运维手动设置才有
  • -ProjectId: 将要创建 MergeRequest 的仓库项目 Id 值。可选，默认将通过环境变量获取 GitLab 的 $CI_PROJECT_ID 常量
  • -TargetBranch: 将从 SourceBranch 合并到 TargetBranch 分支。可选，默认将通过环境变量获取 GitLab 的 $CI_DEFAULT_BRANCH 分支，也就是仓库的默认分支
  • -SourceBranch: 将从 SourceBranch 合并到 TargetBranch 分支。可选，默认将通过环境变量获取 GitLab 的 $CI_COMMIT_BRANCH 分支，也就是当前 CI 正在运行分支
  • -Title: 提交 MergeRequest 的标题。可选，默认是 "[Bot] Automated PR to fix formatting errors" 字符串

放在 .gitlab-ci.yml 文件例子如下：

stages:
  - build

ReleaseToDev:
  # 自动从 release 分支合并到 dev 分支的工具
  stage: build
  script:
    - "chcp 65001"
    - 'dotnet tool update -g dotnetCampus.GitLabMergeRequestCreator' # 安装或更新工具
    - 'CreateGitLabMergeRequest -Title "Merge release to dev"' # 自动创建合并 Release 分支到 Dev 分支
  only:
    - release

AutomateFormatCodeAndCreateGitLabMergeRequest

自动格式化代码，格式化完成之后自动提 GitLab 的 MergeRequest 工具

格式化代码使用 dotnet format 命令，受仓库的 .editorconfig 文件影响

安装方法如下

dotnet tool install -g dotnetCampus.GitLabCodeFormatBot

使用方法如下

AutomateFormatCodeAndCreateGitLabMergeRequest -Token sL5nY_aSNsY2FN9HYjuB

参数完全包含 GitLabMergeRequestCreator 的参数，特有的参数描述如下

  • -CodeFormatBranch: 用于给格式化代码使用的分支，默认是 t/bot/FixCodeFormatting 分支
  • -GitLabPushUrl: 用于上传代码的 GitLab 地址，格式如 [email protected]:lindexi/foo.git 地址。可选，默认将通过环境变量拼接 git@$CI_SERVER_HOST:$CI_PROJECT_PATH.git 地址
  • 其他参数，参阅 GitLabMergeRequestCreator 的参数

放在 .gitlab-ci.yml 文件例子如下：

stages:
  - build

FormatCode:
  # 自动格式化代码机器人，将使用 dotnet format 格式化
  # 格式化规则参阅 .editorconfig 文件
  stage: build
  script:
    - "chcp 65001"
    - "dotnet tool update -g dotnetCampus.GitLabCodeFormatBot"
    - "AutomateFormatCodeAndCreateGitLabMergeRequest"
  only:
    - dev

SyncTool

同步文件夹工具，可进行跨平台进行单向同步文件夹的工具。此工具开发的背景是我有一个需要在 Linux 上进行测试的应用，但我习惯在 Windows 进行开发，于是我就需要不断在 Windows 进行构建然后将输出的应用拷贝到 Linux 机器上，为了提升开发效率就开发了此工具

此工具的特点是支持超长次数的文件占用重试以及较低延迟的同步。此工具设计上只是用来拷贝构建输出内容到另一台机器

安装方法如下

dotnet tool install -g dotnetCampus.SyncTool

或从 Release 中下载已提前构建的二进制文件，规避同步机器不带 dotnet SDK 问题

使用方法如下，使用时需要分为服务端和客户端，从服务端单向将文件同步给到客户端

服务端命令如下

SyncTool serve [参数]

服务端的参数如下

  • -p 或 -Port : 开放监听的端口。可选，不填则工具将会自己随便找一个可用端口
  • -f 或 -Folder : 同步的文件夹路径。可选，不填将使用当前的工作路径

客户端命令如下

SyncTool sync [参数]

客户端的参数如下

  • -a 或 -Address : 同步服务的地址。必填，格式如 http://127.0.0.1:56621 等地址
  • -f 或 -Folder : 本地同步的文件夹。可选，不填默认为工作路径

制作符合 UOS 规范的 deb 安装包的工具

可以打包出符合 UOS 规范的 deb 安装包的工具

提供两个不同的使用方式，分别是命令行方式和配合 csproj 的 NuGet 包方式

命令行方式通过 dotnet tool 方式使用，先使用以下命令安装工具

dotnet tool update -g Packaging.DebUOS.Tool

将已经准备好的符合 UOS 安装包文件组织规范的文件夹打包为 deb 安装包：

dotnet dpkg-debuos -b C:\lindexi\DebPacking -o C:\lindexi\UOS\Foo.deb

配合 csproj 的 NuGet 包方式：

请通过 NuGet 管理器或采用如下代码编辑 csproj 文件安装 Packaging.DebUOS 库

  <ItemGroup>
    <PackageReference Include="Packaging.DebUOS" Version="1.0.0">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>
  </ItemGroup>

接着添加一些必要的配置参数，比如用来配置 UOS 的 AppId 的 UOSAppId 属性，如以下代码示例。更多的属性配置请参阅下文

  <PropertyGroup>
    <UOSAppId>com.xx.xxx</UOSAppId>
  </PropertyGroup>

通过如下命令行发布时，即可打出符合 UOS 规范的 deb 包

dotnet publish -t:CreateDebUOS -c release -r linux-x64 --self-contained

更多请参阅 Packaging.DebUOS 工具

相似的项目

dotnetcore/FlubuCore: A cross platform build and deployment automation system for building projects and executing deployment scripts using C# code.

感谢

排名无先后