當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

持续集成之 Nuget 进阶

發布時間：2023/12/4 编程问答 24 豆豆

生活随笔收集整理的這篇文章主要介紹了持续集成之 Nuget 进阶小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

持續集成之 Nuget 進階

Intro

之前介紹了一篇基于 Azure pipeline 的 nuget 包的持續集成配置，但是比較粗糙，這里介紹一下結合 Cake 實現更優雅的 nuget 包發布流程。

實現目標：

分支(除master/preview)有代碼 push 或者 pr 時自動 build

preview 分支有代碼 push 的時候將 build 并將發布 preview 版的 nuget 包

master 分支有代碼 push 的時候將 build 并將發布穩定版的 nuget 包

什么是Cake？為什么要使用 Cake?

Cake 是C# Make的縮寫，是一個基于C# DSL的自動化構建系統。它可以用來編譯代碼，復制文件以及文件夾，運行單元測試，壓縮文件以及構建Nuget包等等。

熟悉大名鼎鼎的Make的小伙伴，應該已經知道Cake大致是個什么樣的工具了，Cake具有以下幾個特點：

方便編寫：使用基于C#的DSL，非常易于編寫自動化的腳本。

跨平臺: 基于Roslyn和Mono來編譯我們寫的自動化腳本，使得它可以運行在windows，linux，mac上。

可靠的：可以建立在自己的機器上，也可以建立在像AppVeyor，TeamCity，TFS，VSTS或Jenkins這樣的CI系統上，都可以以相同的方式運行。

豐富的工具集：支持MSBuild，MSTest，xUnit，NUnit，Nuget，ILMerge，Wix和SignTool等等，以及支持豐富的插件（Cake Addins）。

開源：基于MIT開放源代碼（Cake on Github），并且是.NET 基金會支持的一個項目（Cake on dotnet foundation）。

最初做自動化發布的時候自己嘗試去寫 powershell 和 bash shell 腳本，但是寫的多了一點會發現，很多語法不太一致，往往寫一個功能要寫一個 powershell 腳本再寫一個 bash shell 腳本，徒然增加自己的工作量，而且有時候會發生一些奇怪的問題，在Windows上的路徑和Linux的路徑有時候會不同，使用了 Cake，我們就只需要專注于腳本要執行的過程，不需要關注 powershell 和 bashshell 的不同，不需要太多關注于 windows 和 linux 的差異。

Cake 文檔
Cake api

使用 Cake

Cake 有 Visual Studio Code 插件，可以基于 VSCode 來編輯 cake 腳本

Cake 腳本示例

cake 主要文件：

build.ps1/build.sh 啟動腳本，build.ps1 為 Windows 系統上要執行的 powershell 腳本，build.sh 為 *nix 上要執行的 shell 腳本
build.cake 實際執行的腳本，定義各種 build 需要的 task
tools/packages.config 啟動腳本需要的 nuget 包

添加 cake 支持之后，你可能需要修改 .gitignore，官方推薦的 gitignore 是這樣的

tools/** !tools/package.config

實際使用下來，即使沒有 package.config 也是可以正常工作的，可以簡化為一條

tools/**

示例項目

這里以我的一個個人開源項目 WeihanLi.Redis 為例

cake 腳本

/// // ARGUMENTS /// var target = Argument("target", "Default"); var configuration = Argument("configuration", "Release"); var solutionPath = "./WeihanLi.Redis.sln"; var srcProjects = GetFiles("./src/**/*.csproj"); var testProjects = GetFiles("./test/**/*.csproj"); var artifacts = "./artifacts/packages"; var isWindowsAgent = (EnvironmentVariable("Agent_OS") ?? "Windows_NT") == "Windows_NT"; var branchName = EnvironmentVariable("BUILD_SOURCEBRANCHNAME") ?? "local"; /// // SETUP / TEARDOWN /// Setup(ctx => { // Executed BEFORE the first task. Information("Running tasks..."); PrintBuildInfo(); }); Teardown(ctx => { // Executed AFTER the last task. Information("Finished running tasks."); }); /// // TASKS /// Task("clean") .Description("Clean") .Does(() => { var deleteSetting = new DeleteDirectorySettings() { Force = true, Recursive = true }; if (DirectoryExists(artifacts)) { DeleteDirectory(artifacts, deleteSetting); } }); Task("restore") .Description("Restore") .Does(() => { foreach(var project in srcProjects) { DotNetCoreRestore(project.FullPath); } }); Task("build") .Description("Build") .IsDependentOn("clean") .IsDependentOn("restore") .Does(() => { var buildSetting = new DotNetCoreBuildSettings{ NoRestore = true, Configuration = configuration }; foreach(var project in srcProjects) { DotNetCoreBuild(project.FullPath, buildSetting); } }); Task("test") .Description("Test") .IsDependentOn("build") .Does(() => { var testSettings = new DotNetCoreTestSettings{ NoRestore = true, Configuration = configuration }; foreach(var project in testProjects) { DotNetCoreTest(project.FullPath, testSettings); } }); Task("pack") .Description("Pack package") .IsDependentOn("test") .Does(() => { var settings = new DotNetCorePackSettings { Configuration = configuration, OutputDirectory = artifacts, VersionSuffix = "", NoRestore = true, NoBuild = true }; if(branchName != "master"){ settings.VersionSuffix = $"preview-{DateTime.UtcNow:yyyyMMdd-HHmmss}"; } foreach (var project in srcProjects) { DotNetCorePack(project.FullPath, settings); } PublishArtifacts(); }); bool PublishArtifacts() { if(!isWindowsAgent) { return false; } if(branchName == "master" || branchName == "preview") { var pushSetting =new DotNetCoreNuGetPushSettings { Source = EnvironmentVariable("Nuget__SourceUrl") ?? "https://api.nuget.org/v3/index.json", ApiKey = EnvironmentVariable("Nuget__ApiKey") }; var packages = GetFiles($"{artifacts}/*.nupkg"); foreach(var package in packages) { DotNetCoreNuGetPush(package.FullPath, pushSetting); } return true; } return false; } void PrintBuildInfo(){ Information($@"branch:{branchName}, agentOs={EnvironmentVariable("Agent_OS")} BuildID:{EnvironmentVariable("BUILD_BUILDID")},BuildNumber:{EnvironmentVariable("BUILD_BUILDNUMBER")},BuildReason:{EnvironmentVariable("BUILD_REASON")} "); } Task("Default") .IsDependentOn("pack"); RunTarget(target);

我這里使用 Azure pipeline 來實現持續集成，上面的里面有一些Azure pipeline 的變量，實際執行 build.ps1 腳本

Azure pipeline config

trigger: - '*' pool: vmImage: 'vs2017-win2016' steps: - script: dotnet --info displayName: 'dotnet info' - powershell: ./build.ps1 displayName: 'Powershell Script' env: Nuget__ApiKey: $(nugetApiKey) Nuget__SourceUrl: $(nugetSourceUrl)

nugetApiKey 是比較敏感的信息，在 Azure Pipeline 里的 Variables 的 Secret 變量，這里需要轉換一下，不然，直接從環境變量讀取是讀取不到的，詳細參考：https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch&viewFallbackFrom=vsts#secret-variables

通過以上腳本可以本文開篇提到的目標：

分支(除master/preview)有代碼 push 或者 pr 時自動 build

preview 分支有代碼 push 的時候將 build 并將發布 preview 版的 nuget 包

master 分支有代碼 push 的時候將 build 并將發布穩定版的 nuget 包

preview 和 master 分支可以設置 branch policy，設置只能由 pull request 合并，不能直接 push 代碼，如果必須要先發布 preview 再發布穩定版 nuget 包，可以添加自定以限制，限制 master 分支的代碼只能從 preview 分支通過 pr 合并

Reference

https://www.cnblogs.com/linianhui/p/cake-overview.html
https://www.cakebuild.net/
https://github.com/cake-build/cake
https://github.com/WeihanLi/WeihanLi.Redis
https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch&viewFallbackFrom=vsts#secret-variables

總結

以上是生活随笔為你收集整理的持续集成之 Nuget 进阶的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

进阶
NuGet