共用方式為

封裝和發佈擴展件

  • 發行項

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

開發擴充功能之後，您可以封裝併發佈至 Visual Studio Marketplace。 Marketplace 是 Microsoft 提供的全球資源庫，包含私有和公用擴充功能、整合和其他供應專案。

注意

如需延伸模組指令清單檔案中可用之探索屬性的資訊，以協助使用者探索及瞭解您的延伸模組，請參閱 延伸模組指令清單參考。

必要條件

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

  • 安裝擴充套件封裝工具（TFX）。 在命令提示字元中執行 npm install -g tfx-cli 。
  • 請確定已授與適當的許可權，以使用任何影像，例如圖示、標誌、螢幕快照等等。
  • 包含一個詳細的 overview.md 檔案，以描述您在 Marketplace 中的項目。
  • 包含一個至少為 128x128 像素的擴充功能圖示。
  • 當您參考Microsoft產品時，請使用完整名稱取代縮寫，例如 Azure DevOps 與 AzDO 或 - 任何其他縮寫。
  • 避免在延伸模組的名稱中使用品牌名稱。

建立發行者

所有延伸模組和整合，包括來自Microsoft的延伸模組，都有發行者。 任何人都可以建立發行者，並在其下發佈延伸模組。 如果有小組在開發擴充功能，您也可以允許其他人存取您的發行者。

通常，建立發行者的使用者擁有該發行者。 您也可以與其他使用者共享發行者。

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

  2. 如果您還不是現有發行者的成員， + 建立發行者。 在 [發行者名稱] 欄位中輸入名稱。 ID 欄位應該根據您輸入的名稱自動設定。

    顯示醒目提示按鈕 [建立發行者] 的螢幕快照。

    注意

    記下標識碼，因為您需要在延伸模組的指令清單檔中加以設定。

    如果未提示您建立發行者，請向下捲動至頁面底部，然後在相關網站下方選取發佈延伸模組。

    • 指定發行者的標識碼，例如： mycompany-myteam。 此標識碼會作為您的延伸模組宣告檔案中 publisher 屬性的值。
    • 指定發行者的顯示名稱，例如： My Team

  3. 檢閱 市集發行者合約，然後選取 建立。

    創建擴充套件的發布者

發行者創建之後，系統會引導您管理項目，但沒有任何項目。

打包您的擴充套件

若要上傳您的延伸模組，請將它封裝為 VSIX 2.0 相容的 .vsix 檔案。 Microsoft提供跨平臺命令行介面 （CLI） 來封裝和發佈延伸模組。

  1. 開啟您的延伸模組指令清單檔案 （vss-extension.json），並將欄位的值 publisher 設定為發行者的標識碼。 例如：

    {
    ...
    "id": "my-first-extension",
    "publisher": "AnnetteNielsen",
    ...
}

  2. 從命令提示字元中，從延伸模組目錄執行 TFX 工具的封裝命令。

    npx tfx-cli extension create

    顯示訊息，指出您的延伸模組已成功封裝：

    === Completed operation: create extension ===
- VSIX: C:\my-first-extension\AnnetteNielsen.my-first-extension-1.0.0.vsix
- Extension ID: my-first-extension
- Extension Version: 1.0.0
- Publisher: AnnetteNielsen

注意

每次更新時，請在清單檔中增加擴充套件或整合的版本號。
使用命令行切換 --rev-version。 此選項將您的擴充功能的 修補程式版本號碼遞增，並將新版本儲存至清單。

檢查套件大小

在封裝 vsix 之後檢查其大小。 如果大於 50 MB，您需要將其優化。 若要這樣做，請參閱下列考慮：

  • 在延伸套件中只指定一次，以去除重複的通用相依性。
  • 在運行時間或安裝期間擷取相依性，而不是在套件中包含相依性。 請考慮在執行時使用工具安裝程式庫來抓取工具相依性。 此方法會依私人代理程式的版本快取工具，以防止每次組建下載。 工具安裝程式庫無法在沒有網路連線的情況下運作（沒有網際網路），這一點應該在任務描述或說明文件中提及。
  • 使用 WebPack 來將工作的相依性樹狀結構。

發佈延伸模組

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

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

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

    螢幕快照顯示「新增擴充套件」的下拉功能表及已選取的「Azure DevOps」。

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

    此螢幕快照顯示上傳新的 Azure DevOps 擴充功能。

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

    顯示已發行延伸模組清單中延伸模組的螢幕快照。

此時，任何帳戶都看不到您的延伸模組，而且在您共用它之前無法安裝。

注意

Microsoft在每個已發佈的新和更新的擴充套件上執行病毒掃描。 在掃描結果顯示無問題之前，我們不會在 Marketplace 中發佈擴充套件以供公共使用。 如此一來，我們也會避免在 Marketplace 頁面上呈現不適當的或冒犯性內容。

共用您的擴充功能

在 Azure DevOps 中安裝擴充功能之前，請先與組織共用您的延伸模組。 若要共用延伸模組，請執行下列工作：

  1. 從 Marketplace 管理入口網站中，從清單中選取您的擴充功能，以滑鼠右鍵按兩下，然後選擇 [共用/取消共用] 或 [發佈/取消發佈]，視擴充功能而定。

    選單選項[共用/取消共用] 的螢幕快照。

  2. 選取 [ 組織]，然後輸入您組織的名稱。 選取 [輸入]。

    Enter 按鈕的螢幕快照。

  3. 關閉面板。

您的延伸模組現在可以安裝至此組織。

安裝您的延伸模組

若要安裝您的共用延伸模組，請執行下列步驟。

  1. 在 Marketplace 中，選取您的延伸模組以開啟其概觀頁面。

    [概觀] 頁面的螢幕快照。

    注意

    因為您的延伸模組是私人的，所以只有您和組織的成員才能看到此頁面。

  2. 選取 免費取得 以開始安裝程式。 從下拉功能表中選取您與共用延伸模組的組織。

    顯示延伸模組安裝對話框的螢幕快照。

  3. 選擇 [安裝]。

恭喜！ 您已將擴充功能安裝到組織，並已準備好試用。

試用擴充功能

  1. 在安裝精靈結束時，選取 繼續至組織 以前往安裝此擴充功能的組織首頁(https://dev.azure.com/{organization})。

  2. 重新整理您的瀏覽器。

  3. 開啟 [組織設定]，然後選取 [ 擴充功能]。

    [組織設定]、[延伸模組] 頁面的螢幕快照。

您應該會在 [ 已安裝 ] 索引標籤上看到新的延伸模組。

偵錯您的擴充功能

若要使用 Visual Studio 或 Browser Developer Tools 對延伸模組進行偵錯，請新增 baseUri 屬性來變更指令清單。 此動作可加速開發，而不需要在每次變更原始程式碼時重新部署擴充功能。

{
    ...
    "baseUri": "https://localhost:44300",
    ...
}

當您變更指令清單時，它會從本機 Web 伺服器實例載入擴充功能。 例如，Visual Studio 中的 IISExpress。 變更指令清單之後，僅部署並安裝此偵錯延伸模組一次。

注意

在 SSL 模式中執行本機網頁伺服器，因為 Azure DevOps 會要求從安全來源提供網頁。 否則，您會在擴充功能 IFRAME 載入期間，於瀏覽器控制台中收到錯誤。

更新擴充功能

若要變更已發行的延伸模組，請加以更新。

提示

我們建議更新延伸模組，而不是移除和重新上傳。 我們也建議有兩個延伸模組，例如 publisher.extension 和 publisher.extension-dev。 Publisher.extension 在 Marketplace 中是公用的，客戶可以在其 Azure DevOps 組織中安裝它。 Publisher.extension-dev 在 Marketplace 中保持隱私，並可以與您所擁有和控制的組織分享。 您不需要維護延伸模組的兩個原始程式碼複本。 您可以維護兩個指令清單檔案 -- 每個延伸模組的一個，在封裝擴充功能期間，您可以將個別的指令清單檔案提供給 tfx-cli 工具。 如需工具所需自變數的詳細資訊，請參閱 TFX 擴充功能命令。

  1. 從顯示的專案清單中選取延伸模組。
  2. 以滑鼠右鍵點擊，然後選取更新，例如。
  3. 驗證您的擴充功能。
  4. 例如，對生產版本 publisher.extension進行相同的更新。
  5. 流覽至 .vsix 以取得您的延伸模組並上傳。

延伸模組的更新版本會自動安裝到已安裝它的帳戶。 未來安裝擴充功能的新帳戶也會收到最新版本。

將您的擴充功能設為公用

當您開發 Marketplace 的延伸模組或整合時，請將其保留為私人。 若要公開提供擴充功能，請將 指令清單中的公用旗標 設定為 true 。

資格

若要在 Marketplace 上擁有公開清單，您的整合或擴充功能必須符合下列資格：

  • 使用或擴充 Azure DevOps。
  • 貴使用者或貴公司擁有、開發及取得授權，以分發及宣傳整合或擴展功能。
  • 正積極維護擴充功能或整合。

Microsoft 也可能會要求進行示範，並檢閱您規劃在其 Marketplace 專案中的內容。

頂尖出版商

Top Publisher 程式僅適用於具有 Azure DevOps 延伸模組或整合的發行者。 不適用於 Visual Studio IDE 和 Visual Studio Code 擴充功能發行者。

Top Publisher 徽章的螢幕快照。

Top Publisher 計劃通過優異的政策、品質、可靠性和支援，表彰那些對客戶和 Marketplace 展現高度承諾的發行商。 成為頂級發行者之後，您所有的公開發行都會顯示頂級發行者的徽章。

頂級發行者要求

Marketplace 的頂級發行者計畫旨在協助您具信心地評估或取得 Azure DevOps 延伸模組與整合。 Top Publisher 徽章表示發行者會透過示範原則、品質、可靠性和支援，向客戶和 Marketplace 展示對客戶和 Marketplace 的承諾。 它適用於具有一或多個全域 Azure DevOps 延伸模組或整合的發行者，不適用於 Visual Studio IDE 和 Visual Studio Code 擴充功能發行者。

Marketplace 會在仔細檢閱發行者之後，跨下列參數將徽章指派給發行者：

  • 隱私權原則
  • 授權原則
  • 支援原則
  • 文件
  • 問答回應性
  • 他們產品的評等和評論
  • 其產品的主動採用和安裝數量
  • 管理至少一個 Azure DevOps 公開擴展功能
  • 具有超過 5,000 次安裝的公用套件和活躍安裝數量超過 1000 個

當您從頂級發行者取得擴充功能時，您可以期待及時的支援和良好的整體體驗。 查看頂尖出版商的作品。

如需將原則新增至供應專案的詳細資訊，請參閱 延伸模組清單。

  1. 更新您的發行者資料。

    透過發行者簡介，您可以在單一位置展示所有產品，以及重要的發行者相關資訊。 若要提供設定檔中顯示的資訊，請執行下列步驟：

    a. 請使用您用來在 Visual Studio Marketplace 中發佈及管理供應項目的帳戶登入https://marketplace.visualstudio.com/manage/publishers。

    b. 選取發行者，然後在 [詳細數據] 索引標籤中完成 [關於您] 區段。 您Microsoft發行者相關區段的螢幕快照。 c. 儲存您的變更，然後選取 [ 檢視配置檔 ] 以查看其顯示給取用者的方式。 您可以使用此個人檔案頁面來熱情地推廣您的產品或服務。

注意

此程式會認證發行者，而不是軟體，或其延伸模組和整合的安全性。 建議您在評估發行者的產品時，檢閱 安全性資料。 如果您從頂級發行者取得擴充功能，但對體驗不滿意，請考慮先與發行者互動。

申請成為頂尖發行者

  1. 使用您在 Marketplace 中發佈和管理供應項目的帳戶，登入 Marketplace 管理入口網站。
  2. 選取發行者，然後移至其 Top Publisher 索引標籤。若要顯示此索引標籤，必須至少有一個或多個全域 Azure DevOps（伺服器/服務）延伸模組或整合。
  3. 如果您符合先前列出的需求，而且是出版商的擁有者，您可以申請專案。 在應用程式時，系統會傳送電子郵件給 Marketplace 小組，以檢閱您的案例。 他們會在10個工作天內回應後續步驟、釐清問題或授與徽章。

小組可能會考慮其他參數，例如主動採用您的供應專案、安裝/開始使用計數，以及在授與徽章之前，& 評論評等。 Microsoft隨時保留授與、拒絕或撤銷 Top Publisher 徽章的權利。

發行者是頂級發行者之後，其所有未來的更新和供應專案都必須符合先前列出的需求。

回應市集擴充功能評價

您可以回應客戶在 Visual Studio Marketplace 中為延伸模組留下的評論。 如果您有下列其中一個許可權，請尋找並選取 [檢閱] 旁的 [回復 ]：擁有者、建立者或參與者。

您只能留下一個回應。 避免使用評論作為支持論壇。 如果您需要更多詳細數據，請為檢閱者提供支持別名以連絡。 然後，您可以從外部解決他們的問題，並以解決方案更新您的回覆。

發行者回應的指導方針

讓 Visual Studio Marketplace 保持開放、邀請、尊重和實用的位置，讓客戶尋找、試用、安裝及檢閱擴充功能。 溝通在保持健康社區方面發揮了重要作用。 為了協助建立此環境，以下是發行者回應客戶評論的指導方針。 深入思考客戶互動，並反思 Marketplace 嘗試建立的客戶體驗精神。

  • 保留評論用於客戶留言。 使用 回覆 僅限於回應評論。
  • 尊重所有客戶意見。 在沒有辯論、批評或爭論的情況下，將評論視為意見反應。
  • 請確定您的回應會增加價值，且與您客戶的批註相關。
  • 專注於精確地解決問題。 如果您需要更多詳細數據，請要求客戶透過電子郵件連絡您，而不是在評論中討論。 當您解決問題時，請更新您的回復，說明解決方案。 您可以編輯您的回復，就像客戶可以編輯其評論一樣。
  • 將任何不適當的評論，例如垃圾郵件、濫用或冒犯性內容，標記給我們審查。

要求撤銷評論

身為發行者，如果回報的問題是由於 Marketplace 或基礎平臺造成的，您可以申訴以撤銷檢閱。 如果問題有效，Marketplace 系統管理員會取消評等。 您可以在 延伸模組中樞頁面上從評等和檢閱區段提出上訴 。

取消發佈擴充功能

如果您不想再在 Marketplace 中提供免費延伸模組，您可以取消發佈免費擴充功能。

在下列案例中，請考慮從 Marketplace 移除擴充功能：

  • 您已開發新的延伸模組，不再想要提供目前的擴充功能。
  • 您的延伸模組發生問題，而且您想要從 Marketplace 中移除它，直到您解決問題為止。
  • 您錯誤地將擴充功能發佈為公用。

必須符合特定準則，才能取消發佈或移除延伸模組：

動作 需求
取消發布 只有 免費延伸模組 可能未發佈。
移除 您的延伸模組必須安裝 零 （0） 才能移除。

重要

如果您因為法律或安全性問題而必須移除擴充功能，請在 開發人員社群 連絡客戶支援。 我們會檢閱要求，並手動刪除延伸模組。

  1. 選取發行者頁面上的延伸模組，然後選擇功能表上的 [取消發佈]。

    您的延伸模組會立即從 Marketplace 解除發布，且新使用者無法安裝。 您的擴充功能的評等和評論將維持不變。

若要在 Marketplace 中再次提供您的擴充功能，請從選單中選取 [發佈]。

如果您的延伸模組沒有安裝，您可以選擇從 Marketplace 完全移除它。 若要這樣做，請從功能表中選取 [移除]。 您無法反轉此動作。

延伸報告中心

在您的擴充功能於 Visual Studio Marketplace 中提供後，您可以使用報表功能 。 透過這項功能，您可以追蹤及分析延伸模組的執行方式，並採取必要的動作。 若要流覽延伸模組中樞，請流覽至您的 發行者頁面，然後選取延伸模組，或選取延伸模塊詳細數據頁面上的 [報表] 連結。

收購

您可以在此頁籤中查看所選期間內的獲取相關資料。

  • 選定期間內的整體取得彙整
  • 透過延伸模組下載數量匯總獲取，Azure DevOps 連線安裝免費的擴充功能。
  • 按試用情況匯總取得的採購，連接至 Azure DevOps 的付費擴展
  • Azure DevOps 和已連線伺服器的擴充頁面檢視和資料取得的每日趨勢
  • 從頁面檢視轉換成下載數的百分比

對於付費延伸模組，購買和試用的所有交易詳情包含日期、組織名稱、試用結束日期和數量。 您可以使用聯絡 動作與使用者溝通。 如需詳細資訊，請參閱本文稍後提供的 聯繫人 一節。

解除安裝

您可以檢視下列統計資料：

  • 有多少組織卸載您的擴充功能
  • 卸載延伸模組的每日趨勢
  • 卸載過程中分享的詳細意見反應
  • 熱門卸載原因

您可以使用搜尋文字和日期，從詳細的意見反應中分析及繪製更多見解。

針對付費擴充功能，您可以使用 聯絡 動作與您的用戶溝通。 本文稍後提供的聯絡資訊一節， 以獲取更多詳情。

評等和評論

此選項卡提供下列資訊。

  • 所選期間的平均評分與整體評分比較
  • 依檢閱者數目的平均評等
  • 平均評等的每日趨勢

詳細資訊區段以交易檢視的方式提供所有的評論和回覆。

您可以 回覆 評論或 編輯 先前的回應，並更妥善地管理與擴充功能用戶之間的互動。 如果回報的問題是因為 Marketplace 或基礎平臺，您也可以 上訴 來取消評等。 如果問題有效，我們會取消評等。

管理互動

Q & A 標籤提供您擴充功能使用者所有問題的概覽，並將未回應的查詢置於頂端。 您可以回復或編輯先前的回應，以更妥善地管理與延伸模組用戶的互動。

匯出至 Excel

[報表] 頁面中可用的所有數據元素也可以 XLS 格式下載，以協助建立您自己的自定義報表。

連絡人​​

針對付費延伸功能，您可以使用 聯繫 動作來與您的用戶通訊。 此功能僅適用於具有擴充功能上參與者+ 存取權的發行者。

Marketplace 訊息代理程式會與用戶進行第一次通訊，因為我們的隱私策略不允許直接共用客戶電子郵件位址。 只有選擇進行通訊的使用者會收到電子郵件。 傳送通訊後，會更新組織的最後聯絡日期。

重要

遵循交易式和促銷通訊的指引。 發現要傳送促銷通訊或垃圾郵件用戶的發行者會新增至封鎖清單，並失去所有擴充功能 聯繫人 功能的存取權。

交易式通訊：傳輸繼續使用擴充功能或服務所需重要資訊的電子郵件，例如：

  • 重大安全性通知
  • 交易確認
  • 產品召回通知
  • 特定意見反應要求
  • 服務停止通知

促銷電子郵件：用來行銷延伸模組、產品、服務、網站或活動的電子郵件，例如：

  • 活動或網路廣播的邀請
  • 新行銷或合作夥伴計劃的相關信息
  • 優惠以取得增值內容
  • 包含促銷內容的電子報

如需詳細資訊，請參閱 Marketplace 發行者合約。

術語 說明
頁面檢視 擴充功能詳細頁面檢視次數總數。 重複觀看次數會被計算。
Azure DevOps Services 會安裝 安裝擴充功能的組織總數。 在相同的組織上重複安裝會計算。
Azure DevOps Server 會安裝 延伸模組安裝的集合總數。 在相同的集合上重複安裝的次數會被計算。 無法取得中斷連線的伺服器資料。