Empacotar e publicar uma integração no Marketplace

Serviços de DevOps do Azure | 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 de DevOps do Azure. 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.

Reúna os ativos necessários

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

Criar uma conta de editor

Todas as extensões ou integrações, incluindo as da Microsoft, devem 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 editor existente, selecione + Criar um editor.
   Insira um nome de editor; o campo ID é preenchido automaticamente com base na sua entrada.

   

   Observação

   • Certifique-se de que o nome do editor esteja dentro de 16 caracteres para caracteres de múltiplos bytes.
   • Salve o ID do editor — você precisa dele no arquivo de manifesto da sua extensão.

   Se não lhe for pedido para criar um editor, desloque-se para Publicar extensões sob Sites relacionados.

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

3. Reveja o Contrato de Editor do Marketplace 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 seus 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:
   • O seu logótipo de integração (128x128 pixels)
   • Capturas de ecrã (1366x768 pixels)
3. Crie um overview.md arquivo para descrever sua integração. Para obter mais informações, consulte GitHub Flavored Markdown.
4. Crie um vss-integration.json arquivo, que é o arquivo de manifesto da sua listagem do Marketplace. Para obter mais informações, consulte a referência do manifesto de extensão.

Preencha o manifesto de 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). Estas informações são utilizadas para apresentar a sua integração aos utilizadores no Marketplace.

1. Preencha o seu arquivo vss-integration.json 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:

Entenda a página de detalhes

• 1 - Descrição
• 2 - ícone
• 3 - categorias
• 4 - Capturas de ecrã
• 5 - conteúdo (detalhes)
• 6 - Ligações
• 7 - Branding

Empacote seu manifesto e ativos

Instalar a ferramenta de pacote (tfx-cli)

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

npm i -g tfx-cli

Empacote sua integração em um arquivo .vsix

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

Publique sua integração no Marketplace

Assim que a extensão estiver empacotada, poderás carregá-la no Marketplace de um publicador. O identificador publisher especificado no arquivo de manifesto da extensão deve corresponder ao identificador do editor sob o qual a extensão é carregada.

1. No portal de gestão, selecione o seu editor no menu suspenso na parte superior da página.

2. Selecione Nova extensão>Azure DevOps.

   

3. Arraste e solte seu arquivo ou selecione-o para encontrar seu 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ó é visível para você.

   

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

Partilhe 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 testes, pois é a única maneira de executar uma integração durante esses estágios.

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

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

Atualizar um item

Para atualizar uma extensão já publicada, 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 a sua extensão.
4. Aplique as mesmas atualizações à versão de produção, como publisher.extension.
5. Navegue até ao ficheiro .vsix da extensão e carregue-o.

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

Torne a sua integração pública

Para obter informações sobre como tornar a sua integração visível para todos, consulte Tornar o seu anúncio público.