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

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

是否有与 Azure DevOps 或 Team Foundation Server（TFS）集成的工具、服务或产品？ 如果是这样，请通过将其发布到 Visual Studio Marketplace 来帮助用户找到它。 市场是个人和团队的一站式商店，用于查找扩展和增强体验的工具。

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

发布要求

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

• 安装扩展打包工具（TFX）。 从命令提示符运行 npm install -g tfx-cli 。
• 确保授予适当的权限以使用任何图像，例如图标、徽标、屏幕截图等。
• 包括一个全面的 overview.md 文件，用于描述您的市场清单。
• 包括扩展的图标，该图标的大小至少为 128x128 像素。
• 引用Microsoft产品时，请使用全名代替缩写，例如 Azure DevOps 与 AzDO 或其他任何缩写。
• 不要在扩展名称中使用品牌名称。

所需内容

1. 128x128 像素的徽标（PNG 或 JPEG 格式），用于代表您的集成、您自己或您的公司/组织。
2. 显示您的集成的至少一个屏幕截图
3. 行动号召 / 入门 URL（用户应该访问此处以开始进行您的集成）

步骤

发布到市场是一个迭代过程，从创建定义集成和关键发现特征（如屏幕截图、徽标和概述内容）的清单文件开始。 此信息用于将集成呈现给市场上的用户，例如：

适用于 Azure DevOps 的 Jenkins

注意：术语 extension在下面引用的文档中使用。 扩展是另一种类型的市场项目，从发现的角度来看，与集成共享许多相似之处。

创建发布商

所有扩展和集成（包括来自Microsoft的扩展）都有发布者。 任何人都可以创建发布者并在其下发布扩展。 如果某个团队在开发扩展，则您也可以向其他人授予对发布者的访问权限。

一个用户拥有发布者，通常是创建该发布者的用户。 还可以与其他用户共享发布者。

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

2. 如果你还不是现有发布者的成员，+ 创建发布者。 在发布者名称字段中输入名称。 ID 字段应根据输入的名称自动设置。

   

   注释

   记下 ID，因为需要在扩展的清单文件中对其进行设置。

   如果没有被提示创建发布者，请向下滚动到页面底部，然后在“相关网站”下选择“发布扩展”。

   • 为发布者指定标识符，例如： mycompany-myteam 此标识符用作您的扩展清单文件中publisher属性的值。
   • 为发布者指定显示名称，例如： My Team

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

   

发布者创建后，您会被引导去管理条目，但没有任何条目。

创建包含项目清单和其他资产的文件夹

将集成打包为扩展之前，需要创建一个 home 文件夹来包含此文件夹中的一些必需资产：

1. 创建一 images 个名为包含的文件夹：
   • 集成徽标（128x128 像素）
   • 屏幕截图（1366x768 像素）
2. 创建名为 的文件 overview.md
   • 在这里描述您的集成
   • 若要了解有关 Markdown 的详细信息，请参阅 GitHub Flavored Markdown
3. 创建名为 的文件 vss-integration.json
   • 此文件是你的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）

可以使用命令行中的 Node.js组件安装或更新 Azure DevOps 的跨平台 CLI（tfx-clinpm）。

npm i -g tfx-cli

在 .vsix 文件中打包软件集成组件

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

将集成发布到市场

打包扩展后，您可以在某个发布者名下将其上传到应用市场。 publisher 扩展清单文件中指定的标识符必须与上传扩展的发布者的标识符匹配。

1. 在 管理门户中，从页面顶部的下拉菜单中选择发布者。

2. 选择 “新建扩展>Azure DevOps”。

   

3. 拖放文件或将其选中以查找在上一个打包步骤中创建的 VSIX 文件，然后选择“ 上传”。

   

   快速验证后，扩展将显示在已发布的扩展列表中。 别担心，扩展仅对你可见。

   

此时，你的扩展对任何帐户都不可见。 若要使它对其他人可见，需要共享扩展。

分享您的集成

在可以将集成安装到 Azure DevOps 或 TFS 中的组织之前，必须先将其与该组织共享。 共享是开发和测试集成期间的要求，因为它是运行集成的唯一方法。

若要共享集成，请执行以下任务：

1. 从显示的项目列表中选择一个集成项
2. 选择“ 共享 ”按钮
3. 指定要使此集成可见的组织的名称。
   • 例如，若要使集成对 dev.azure.com/fabrikam-fiber-inc 组织可见，请指定 fabrikam-fiber-inc。

更新一项内容

若要更改已发布的扩展，请更新它。

1. 从显示的项列表中选择一个扩展。
2. 右键单击并选择更新来更新publisher.extension-dev。
3. 验证扩展。
4. 请对生产版本publisher.extension进行相同的更新，例如。
5. 浏览到 .vsix 以获取扩展并上传它。

更新的扩展版本会自动安装到已安装扩展的帐户。 将来安装扩展的新帐户也会收到最新版本。

将您的集成公开（对所有人可见）

有关公开集成的信息，请访问 “公开列表”。