Azure Devops 流水線任務插件開發教程 （1/3） —— Quick Start

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

函數	用途
getInput()	獲取流水線上輸入框錄入的值