將整合工具封裝並發佈到 Marketplace

Azure DevOps 服務 |Azure DevOps Server |Azure DevOps Server 2022

本文說明如何在Visual Studio Marketplace上發佈與 Azure DevOps 整合的工具、服務或產品。 在 Marketplace 上發佈可協助使用者探索擴充及增強其 Azure DevOps 體驗的解決方案。 Marketplace 可作為個人和小組尋找整合和擴充功能的核心中樞。

流覽 Marketplace 以查看其他整合和延伸模組的範例。

先決條件

發佈至 Marketplace 之前，必須先符合下列需求清單。

收集必要的資產

• 請提供至少一個整合過程的螢幕截圖。
• 用戶操作動作或啟動使用的 URL。

建立發行者帳戶

每個延伸模組或整合，包括來自Microsoft的擴充功能，都必須有發行者。 任何人都可以建立發行者，並在其下發佈延伸模組。 您也可以與其他使用者共享發行者存取權，例如您的開發小組。

1. 登入 Visual Studio Marketplace 發佈入口網站。

2. 如果您不是現有發行者的一部分，請選取 [+ 建立發行者]。
   輸入發行者名稱;標識元欄位會根據您的項目自動填入。

   

   備註

   • 確保您的發行者名稱在多字節字符的16個字元內。
   • 儲存發行者識別碼—您需要它於延伸模組的指令清單檔案中。

   如果未提示您建立發行者，請卷動至 [相關網站] 底下的 [發佈延伸模組]。

   • 設定唯一的發行者識別碼，例如 mycompany-myteam。 將此數值用於您的 manifest 檔中的 publisher 屬性。
   • 設定顯示名稱，例如 My Team。

3. 檢閱 Marketplace 發行者合約，然後選取 [建立]。

   

建立發行者之後，您可以管理項目，但您發佈之前，項目不會顯示。

整理您的清單和資產

若要組織您的清單和資產，請執行下列步驟：

1. 建立 home 資料夾以儲存必要的資產。
2. 建立 images 資料夾給：
   • 您的整合標誌 （128x128 像素）
   • 螢幕快照（1366x768 像素）
3. 建立檔案 overview.md 來描述您的整合。 如需詳細資訊，請參閱 GitHub Flavored Markdown。
4. 建立 vss-integration.json 檔案，此檔案是您的 Marketplace 清單的資訊檔案。 如需詳細資訊，請參閱 延伸模組指令清單參考。

完成延伸模組指令清單

發行至 Marketplace 時，首先要建立一個定義整合及其重要發現細節的清單檔案（包括螢幕截圖、標誌、概要內容）。 此資訊可用來向 Marketplace 上的用戶呈現您的整合。

1. 使用下列 JSON 填入您的 vss-integration.json 檔案：

   {
       "manifestVersion": 1,
       "id": "myservice",
       "version": "1.0.0",
       "name": "My Service",
       "publisher": "mycompany",
       "description": "Awesome tools to help you and your team do great things everyday.",
       "targets": [
           {
               "id": "Microsoft.VisualStudio.Services.Integration"
           }
       ],    
       "icons": {
           "default": "images/service-logo.png"
       },
       "categories": [
           "Plan and track"
       ],
       "tags": [
           "working",
           "people person",
           "search"
       ],
       "screenshots": [
           {
               "path": "images/screen1.png"
           },
           {
               "path": "images/screen2.png"
           }
       ],
       "content": {
           "details": {
               "path": "overview.md"
           },
           "license": {
               "path": "fabrikam-license-terms.md"
           }
       },
       "links": {
           "getstarted": {
               "uri": "https://www.mycompany.com/help/getstarted"
           },
           "learn": {
               "uri": "https://www.mycompany.com/features"
           },
           "support": {
               "uri": "https://www.mycompany.com/support"
           }
       },
       "branding": {
           "color": "rgb(34, 34, 34)",
           "theme": "dark"
       }
   }
   

2. 按下列參考資料更新 JSON：

需要下列屬性：

下列選擇性屬性可協助使用者探索及瞭解您的擴充功能：

瞭解明細頁面

• 1 - 描述
• 2 - 圖示
• 3：類別
• 4 - 螢幕快照
• 5 - 內容（詳細資料）
• 6 - 連結
• 7 - 商標

封裝您的清單和資產

安裝套件工具 （tfx-cli）

使用 npm安裝或更新適用於 Azure DevOps 的跨平臺 CLI （tfx-cli） ：

npm i -g tfx-cli

在 .vsix 檔案中封裝您的整合

tfx extension create --manifest-globs vss-extension.json

將您的整合發佈至 Marketplace

封裝延伸模組之後，您可以將它上傳至發行者下的 Marketplace。 publisher擴充功能的清單檔中指定的識別碼必須與上傳擴充功能的發行者的識別碼相符。

1. 從管理入口網站中，從頁面頂端的下拉功能表中選取您的發行者。

2. 選擇 新增擴充功能>Azure DevOps。

   

3. 拖放您的檔案，或選取它來尋找您在上一個封裝步驟中建立的 VSIX 檔案，然後選擇 [ 上傳]。

   

   快速驗證之後，您的延伸模組會出現在已發佈的延伸模塊清單中。 別擔心，這個擴充功能只有您可見。

   

此時，任何帳戶都看不到您的擴充套件。 若要讓其他人看得見，您需要共用延伸模組。

分享您的集成

在 Azure DevOps 組織中安裝整合之前，請先與該組織共用。 開發和測試需要共用，因為它是在這些階段執行整合的唯一方式。

若要共用整合，請執行下列步驟：

1. 從顯示的項目清單中選取整合
2. 選取 [共用] 按鈕
3. 指定要顯示此整合的組織名稱。 例如，若要讓 dev.azure.com/fabrikam-fiber-inc 組織看到整合，請指定 fabrikam-fiber-inc。

更新項目

若要更新您已發佈的擴充功能，請執行下列步驟：

1. 從顯示的項目清單中選取您的延伸模組。
2. 以滑鼠右鍵點擊並選取 更新 以更新開發版本，如 publisher.extension-dev。
3. 驗證您的擴充功能。
4. 將相同的更新套用至生產版本，例如 publisher.extension。
5. 瀏覽至擴充功能的 .vsix 檔案並將其上傳。

Azure DevOps 會自動安裝已擁有擴充功能之所有帳戶的更新版本。 新的安裝也會收到最新版本。

將您的整合公開

如需讓所有人看到整合的資訊，請參閱 將您的清單公開。