• azure devops 流水線外掛的示例
  • 概述
  • 如何開始
  • 開發

azure devops 流水線外掛的示例

概述

正如標題所述這是一個簡易的流水線任務外掛的示例，比起官方的要簡單很多，可以讓大家快速上手。

輸入框

流水線執行結果

官方教程: https://docs.microsoft.com/zh-cn/azure/devops/extend/develop/add-build-task?view=azure-devops

如何開始

1. 初始化

## 克隆git庫，並進入目錄
git clone https://github.com/smallidea/azure-devops-extension-pipeline-task-sample.git
cd azure-devops-extension-pipeline-task-sample

## 安裝根目錄下執行命令所需要的包
npm install

## 安裝流水線外掛執行時所需要的包
cd src/tasks/sample && npm i && cd ../../../
 

2. 點選F5可以進行除錯，除錯的相關配置在 .vscode\launch.json 檔案中 ，可參考 使用vs code除錯
3. 執行 npm run publish，裡面的tfs地址和token需要根據具體專案進行修改

   如果需要在流水線中看到debug資訊，CI（管道）中有一個勾選功能“啟用系統診斷”，如果是CD（釋出）需要手動設定System.Debug為true

4. 手動安裝並啟用外掛
   • 集合設定 > 擴充套件 > 瀏覽本地外掛 > 管理本地擴充套件 > 上傳擴充套件 > 瀏覽本地檔案上傳外掛
   • 點選進入外掛詳情 > 免費獲取 > 選擇集合，點選啟用

   官方文件

5. 手動更新外掛
   • 集合設定 > 擴充套件 > 瀏覽本地外掛 > 管理本地擴充套件
   • 找到需要更新的外掛，點選名稱後的三個點 > 選擇更新 > 瀏覽本地檔案上傳外掛

開發

1. 目錄結構

.
├── README.md              
├── develop.md
├── package.json                          npm run 所用到的命令配置
├── src                                   原始碼檔案
│   ├── static                            靜態檔案
│   │   └── images                        目前只有一個logo檔案
│   └── tasks                             流水線任務集合
│       └── sample                        流水線任務示例
│           └── task.json                 任務中的配置
│           └── tsconfig.json             typescript的相關配置
│           └── package.json              引用的包配置，需要在sample目錄下執行npm i
│           └── index.ts                  主檔案
└── vss-extension-sample.json             外掛釋出配置檔案
 

2. API

azure-pipelines-task-lib