Skip to content

integration.md

Latest commit

 

History

History
122 lines (79 loc) · 4.71 KB

integration.md

File metadata and controls

122 lines (79 loc) · 4.71 KB
ms.subservice azure-devops-ecosystem
title Package and Publish an Integration
description How to package and publish your integration to the Visual Studio Marketplace
ms.assetid 61550050-c6d7-40e1-9ea7-030b48b04e3b
ms.topic how-to
monikerRange <= azure-devops
ms.author chcomley
author chcomley
ms.date 06/06/2025

Package and publish an integration to the Marketplace

[!INCLUDE version-lt-eq-azure-devops]

This article explains how to publish your tool, service, or product that integrates with Azure DevOps on the Visual Studio Marketplace. Publishing on the Marketplace helps users discover solutions that extend and enhance their Azure DevOps experience. The Marketplace serves as the central hub for individuals and teams to find integrations and extensions.

Browse the Marketplace to see examples of other integrations and extensions.

Note

For packaging and publishing information for extensions, see Package & Publish Extensions.

Prerequisites

[!INCLUDE ]

Gather required assets

  • At least one screenshot of your integration.
  • Call-to-action or get started URL for users.

Note

  • The term extension is used in referenced documentation. Extensions are another type of Marketplace item and share many similarities with integrations.
  • Need help getting your integration on the Marketplace? Contact us.

Create a publisher account

[!INCLUDE ]

Organize your manifest and assets

To organize your manifest and assets, do the following steps:

  1. Create a home folder to store required assets.
  2. Create an images folder for:
    • Your integration logo (128x128 pixels)
    • Screenshots (1366x768 pixels)
  3. Create an overview.md file to describe your integration. For more information, see GitHub Flavored Markdown.
  4. Create a vss-integration.json file, which is your Marketplace listing's manifest file. For more information, see the extension manifest reference.

Complete the extension manifest

Publishing to the Marketplace starts with creating a manifest file that defines your integration and its key discovery details (screenshots, logos, overview content). This information is used to present your integration to users on the Marketplace.

  1. Fill your vss-integration.json file with the following JSON:

    [!code-javascriptJSON]

  2. Update the JSON using the following references:

[!INCLUDE ] [!INCLUDE ]

Understand the details page

  • 1 - description
  • 2 - icon
  • 3 - categories
  • 4 - screenshots
  • 5 - content (details)
  • 6 - links
  • 7 - branding

Screenshot shows details card for extension in the Visual Studio Marketplace.

Warning

Set the public attribute to false or omit it to prevent your integration from becoming visible to all Marketplace users before you're ready.

Package your manifest and assets

Install the package tool (tfx-cli)

Install or update the cross-platform CLI for Azure DevOps (tfx-cli) using npm:

npm i -g tfx-cli

Package your integration in a .vsix file

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

Note

Increment the version of your extension or integration with every update.
If you haven't updated the version in your manifest, use the --rev-version command line switch. This switch automatically increments the patch version number and saves the new version to your manifest.

Publish your integration to the Marketplace

[!INCLUDE Publish_extension]

Share your integration

Before installing an integration in an Azure DevOps organization, share it with that organization. Sharing is required for development and testing, as it's the only way to run an integration during these stages.

To share an integration do the following steps:

  1. Select an integration from the list of displayed items
  2. Select the Share button
  3. Specify the name of the organization to make this integration visible to. For example, to make an integration visible to the dev.azure.com/fabrikam-fiber-inc organization, specify fabrikam-fiber-inc.

Update an item

[!INCLUDE Update_extension]

Make your integration public

For information on making your integration visible to everyone, see Make your listing public.