持續集成之 Nuget 進階

来源:https://www.cnblogs.com/weihanli/archive/2019/04/08/advanced-nuget-ci.html
-Advertisement-
Play Games

之前介紹了一篇基於 Azure pipeline 的 nuget 包的持續集成配置，但是比較粗糙，這裡介紹一下結合 Cake 實現更優雅的 nuget 包發佈流程。 1.分支(除master/preview)有代碼 push 或者 pr 時 自動 build 2.preview 分支有代碼 push... ...


持續集成之 Nuget 進階

Intro

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

實現目標：

  1. 分支(除master/preview)有代碼 push 或者 pr 時 自動 build
  2. preview 分支有代碼 push 的時候將 build 並將發佈 preview 版的 nuget 包
  3. master 分支有代碼 push 的時候將 build 並將發佈穩定版的 nuget 包

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

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

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

  1. 方便編寫：使用基於C#的DSL，非常易於編寫自動化的腳本。
  2. 跨平臺: 基於Roslyn和Mono來編譯我們寫的自動化腳本，使得它可以運行在windows，linux，mac上。
  3. 可靠的：可以建立在自己的機器上，也可以建立在像AppVeyor，TeamCity，TFS，VSTS或Jenkins這樣的CI系統上，都可以以相同的方式運行。
  4. 豐富的工具集：支持MSBuild，MSTest，xUnit，NUnit，Nuget，ILMerge，Wix和SignTool等等，以及支持豐富的插件（Cake Addins）。
  5. 開源：基於MIT開放源代碼（Cake on Github），並且是.NET 基金會支持的一個項目（Cake on dotnet foundation）。

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

使用 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

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

  1. 分支(除master/preview)有代碼 push 或者 pr 時 自動 build
  2. preview 分支有代碼 push 的時候將 build 並將發佈 preview 版的 nuget 包
  3. master 分支有代碼 push 的時候將 build 並將發佈穩定版的 nuget 包

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

Reference


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 記一次autofac+dapper+mvc的框架搭建實踐
    1，環境 .net framework4.7.2,Autofac,Autofac.Mvc5,sql server 2,動機 公司項目用的是ef，之前留下代碼的大哥，到處using，代碼沒有分層，連復用都麽的，真的是夠了。現在要重構原來的系統，本著高效、簡潔、高耦合性的原則採用autofac + da ...
  • asp.net core系列 50 Identity 授權(中)
    1.5 基於策略的授權 在上篇中，已經講到了授權訪問(authorization)的四種方式。其中Razor Pages授權約定和簡單授權二種方式更像是身份認證(authentication) ，因為只要是合法用戶登錄就能訪問資源。 而角色授權和聲明授權二種方式是真正的授權訪問(authorizat ...
  • ASP.NET Core 入門教程 10、ASP.NET Core 日誌記錄(NLog)入門
    本教程主要內容 ASP.NET Core + 內置日誌組件記錄控制台日誌 ASP.NET Core + NLog 按天記錄本地日誌 ASP.NET Core + NLog 將日誌按自定義LoggerName分類記錄到不同目錄 ASP.NET Core + NLog 按文件大小歸檔記錄本地日誌 NLo... ...
  • DSAPI TreeView節點增刪簡化操作
    將一行或多行字元串添加到TreeView控制項。 函數： 控制項.TreeView控制項.添加路徑節點到TreeView(要添加節點的TreeView控制項,字元串或字元串數組) 示例:將一個多行文本添加到TreeView中作為一個或多個節點。 ABC\1ABC\3ABC\2\1AA\BB\CCAA\BB\ ...
  • C#中USB轉串口的拔插捕獲
    // usb消息定義 public const int WM_DEVICE_CHANGE = 0x219; public const int DBT_DEVICEARRIVAL = 0x8000; public const int DBT_DEVICE_REMOVE_COMPLETE = 0x800 ...
  • 測試live writer
    ...
  • .NET Core下開源任務調度框架Hangfire的Api任務拓展(支持秒級任務)
    HangFire的拓展和使用 看了很多博客，小白第一次寫博客。 最近由於之前的任務調度框架總出現問題，因此想尋找一個替代品，之前使用的是Quartz.Net，這個框架方便之處就是支持cron表達式適合複雜日期場景使用，以及秒級任務。但是配置比較複雜，而且管理不方便，自己開發了個web管理頁面，不過這 ...
  • 博客第一條
    此博客將會記錄日常工作中的一些趣事，得到的經驗，學到的技術。 ...
一周排行
    -Advertisement-
    Play Games
  • C# + WPF 音頻播放器 界面優雅，體驗良好
    前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器，其界面簡潔大方，操作體驗流暢。該播放器支持多種音頻格式（如 MP4、WMA、OGG、FLAC 等），並具備標記、實時歌詞顯示等功能。 另外，還支持換膚及多語言（中英文）切換。核心音頻處理採用 FFmpeg 組件，獲得了廣泛認可，目前 Git ...
  • OAuth2.0授權-gitee授權碼模式
    OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統，完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面，查看已創建應用的Client ID和Clien ...
  • FastReport.OpenSource .Net下開源免費報表列印組件
    解決了這個問題：《winForm下，fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自：https://www.fcnsoft.com/Home/Sho ...
  • 如何在 ASP.NET Core Web API 方法執行前後 “偷偷“ 作一些 “壞“ 事？初識 ActionFilterAttribute
    國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面，接收裸 Win 32 的 WM_Pointer 消息，從消息裡面獲取觸摸點信息，使用觸摸點 ...
  • 在 ASP.NET Core Web API 中使用異常篩選器捕獲和統一處理異常
    前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能，還集成了高性能的輕量級 POS 解決方案，確保頁面載入速度極快，提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • AbpHelper CLI積累與實戰分享
    ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI： ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的，因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 記一次HttpClient使用問題分析
    問題 問題是這樣的：第三方的webapi，需要先調用登陸介面獲取Cookie，訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面，返回的Headers中沒有找到Cookie信息。 分析 首先，使用Postman測試該登陸介面，正常返回Cookie信息，說明是HttpCli ...
  • .NET周刊【9月第3期 2024-09-15】
    國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低，主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上，.NET曾因微軟的閉源策略發展受限，儘管後來推出了跨平臺的.NET ...
  • 我的網站集成ElasticSearch初體驗
    在WPF開發應用中，動畫不僅可以引起用戶的註意與興趣，而且還使軟體更加便於使用。前面幾篇文章講解了畫筆（Brush），形狀（Shape），幾何圖形（Geometry），變換（Transform）等相關內容，今天繼續講解動畫相關內容和知識點，僅供學習分享使用，如有不足之處，還請指正。 ...
  • 第23篇 委托的概述
    什麼是委托？ 委托可以說是把一個方法代入另一個方法執行，相當於指向函數的指針；事件就相當於保存委托的數組； 1.實例化委托的方式： 方式1：通過new創建實例： public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...
所有分類