Empacotar e publicar uma integração ao Marketplace

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Este artigo explica como publicar sua ferramenta, serviço ou produto que se integra ao Azure DevOps no Visual Studio Marketplace. A publicação no Marketplace ajuda os usuários a descobrir soluções que estendem e aprimoram sua experiência no Azure DevOps. O Marketplace serve como o hub central para indivíduos e equipes encontrarem integrações e extensões.

Navegue pelo Marketplace para ver exemplos de outras integrações e extensões.

Pré-requisitos

A lista de requisitos a seguir deve ser atendida antes de publicar no Marketplace.

Coletar ativos necessários

• Pelo menos uma captura de tela da sua integração.
• URL de chamada para ação ou introdução para usuários.

Criar uma conta do publicador

Cada extensão ou integração, incluindo as da Microsoft, deve ter um publicador. Qualquer pessoa pode criar um editor e publicar extensões sob ele. Você também pode compartilhar o acesso do editor com outros usuários, como sua equipe de desenvolvimento.

1. Entre no Portal de Publicação do Visual Studio Marketplace.

2. Se você não fizer parte de um publicador existente, selecione + Criar um editor.
   Insira um nome de editora; o campo de ID será preenchido automaticamente com base na sua entrada.

   

   Observação

   • Certifique-se de que o nome do editor não ultrapasse 16 caracteres no caso de caracteres multibyte.
   • Salve a ID do editor– você precisa dela no arquivo de manifesto da extensão.

   Se você não for solicitado a criar um publicador, role até Publicar extensões em sites relacionados.

   • Defina um identificador de editor exclusivo, como mycompany-myteam. Use esse valor para o publisher atributo em seu manifesto.
   • Defina um nome de exibição, como My Team.

3. Examine o Contrato do Marketplace Publisher e, em seguida, selecione Criar.

   

Depois de criar o editor, você pode gerenciar itens, embora nenhum item apareça até que você publique.

Organize seu manifesto e ativos

Para organizar seu manifesto e ativos, execute as seguintes etapas:

1. Crie uma home pasta para armazenar os ativos necessários.
2. Crie uma images pasta para:
   • Seu logotipo de integração (128 x 128 pixels)
   • Capturas de tela (1366 x 768 pixels)
3. Crie um overview.md arquivo para descrever sua integração. Para obter mais informações, consulte GitHub Flavored Markdown.
4. Crie o arquivo vss-integration.json, que é o arquivo manifesto da sua listagem no Marketplace. Para obter mais informações, consulte a referência do manifesto da extensão.

Completar o manifesto da extensão

A publicação no Marketplace começa com a criação de um arquivo de manifesto que define sua integração e seus principais detalhes de descoberta (capturas de tela, logotipos, conteúdo de visão geral). Essas informações são usadas para apresentar sua integração aos usuários no Marketplace.

1. Preencha seu vss-integration.json arquivo com o seguinte 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. Atualize o JSON usando as seguintes referências:

As seguintes propriedades são necessárias:

As seguintes propriedades opcionais ajudam os usuários a descobrir e aprender sobre sua extensão:

Entender a página de detalhes

• 1 - Descrição
• 2 - ícone
• 3 - Categorias
• 4 - capturas de tela
• 5 - Conteúdo (detalhes)
• 6 – links
• 7 - Branding

Empacotar seu manifesto e ativos

Instalar a ferramenta de pacote (tfx-cli)

Instale ou atualize a CLI multiplataforma do Azure DevOps (tfx-cli) usando npm:

npm i -g tfx-cli

Empacotar sua integração em um arquivo .vsix

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

Publicar sua integração ao Marketplace

Depois que a extensão for empacotada, você poderá enviá-la ao Marketplace sob um publicador. O publisher identificador especificado no arquivo de manifesto da extensão deve corresponder ao identificador do publicador no qual a extensão é carregada.

1. No portal de gerenciamento, selecione seu editor no menu suspenso localizado no topo da página.

2. Selecione Nova extensão>Azure DevOps.

   

3. Arraste e solte o arquivo ou selecione-o para localizar o arquivo VSIX, que você criou na etapa de empacotamento anterior e escolha Carregar.

   

   Após a validação rápida, sua extensão aparece na lista de extensões publicadas. Não se preocupe, a extensão só está visível para você.

   

Neste ponto, sua extensão não está visível para nenhuma conta. Para torná-la visível para outras pessoas, você precisa compartilhar a extensão.

Compartilhe a sua integração

Antes de instalar uma integração em uma organização do Azure DevOps, compartilhe-a com essa organização. O compartilhamento é necessário para desenvolvimento e teste, pois é a única maneira de executar uma integração durante esses estágios.

Para compartilhar uma integração, execute as seguintes etapas:

1. Selecionar uma integração na lista de itens exibidos
2. Selecione o botão Compartilhar
3. Especifique o nome da organização para tornar essa integração visível. Por exemplo, para tornar uma integração visível à organização dev.azure.com/fabrikam-fiber-inc , especifique fabrikam-fiber-inc.

Atualizar um item

Para atualizar uma extensão que você já publicou, execute as seguintes etapas:

1. Selecione sua extensão na lista de itens exibidos.
2. Clique com o botão direito do mouse e selecione Atualizar para a versão de desenvolvimento, como publisher.extension-dev.
3. Valide sua extensão.
4. Aplique as mesmas atualizações à versão de produção, como publisher.extension.
5. Navegue até o arquivo .vsix para sua extensão e faça o upload.

O Azure DevOps instala automaticamente a versão atualizada para todas as contas que já têm a extensão. As novas instalações também recebem a versão mais recente.

Tornar sua integração pública

Para obter informações sobre como tornar sua integração visível a todos, consulte Tornar sua listagem pública.