持續集成之 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
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類