打包集成并将其发布到市场

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

本文介绍如何在 Visual Studio Marketplace 上发布与 Azure DevOps 集成的工具、服务或产品。 在市场中发布可帮助用户发现扩展和增强其 Azure DevOps 体验的解决方案。 市场充当个人和团队查找集成和扩展的中心中心。

浏览市场，以了解其他集成和扩展的示例。

先决条件

在发布到市场之前，必须满足以下要求列表。

收集所需的资产

• 请至少提供一个集成的屏幕截图。
• 行动号召或入门 URL 用于用户。

创建发布者帐户

每个扩展或集成（包括来自Microsoft的扩展或集成）都必须具有发布者。 任何人都可以创建发布者并在其下发布扩展。 还可以与其他用户（例如开发团队）共享发布者访问权限。

1. 登录到 Visual Studio Marketplace 发布门户。

2. 如果你不是现有发布者的一部分，请选择“ + 创建发布者”。
   输入发布者名称;根据条目自动填充 ID 字段。

   

   注释

   • 确保发布者名称在多字节字符的 16 个字符内。
   • 保存发布者 ID - 需要在扩展的清单文件中使用它。

   如果未提示创建发布者，请滚动到“相关网站”下的“发布扩展”。

   • 设置唯一的发布者标识符，例如 mycompany-myteam。 请在清单中的publisher属性中使用此值。
   • 设置显示名称，例如 My Team。

3. 查看 市场发布者协议，然后选择“ 创建”。

   

创建发布者后，可以管理项目，尽管发布前不会显示任何项目。

组织您的货运清单和资产

若要组织清单和资产，请执行以下步骤：

1. 创建一个用于存储所需资产的 home 文件夹。
2. 创建一个images文件夹：
   • 集成徽标（128x128 像素）
   • 屏幕截图（1366x768 像素）
3. 创建一个 overview.md 文件来描述集成。 有关详细信息，请参阅 GitHub Flavored Markdown。
4. 创建一个 vss-integration.json 文件，该文件是市场列表的清单文件。 有关详细信息，请参阅 扩展清单参考。

完成扩展清单

发布到 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

将集成发布到市场

打包扩展后，您可以在某个发布者名下将其上传到应用市场。 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 会自动安装已具有扩展的所有帐户的更新版本。 新安装还会收到最新版本。

公开集成

要了解如何将集成公开给所有人，请参阅 公开你的清单。