Empacotar e publicar uma integração com o Marketplace

Serviços de DevOps do Azure | Azure DevOps Server 2022 - Azure DevOps Server 2019

Você tem uma ferramenta, serviço ou produto que se integra ao Azure DevOps ou ao Team Foundation Server (TFS)? Em caso afirmativo, ajude os usuários a encontrá-lo publicando-o no Visual Studio Marketplace. O Marketplace é um balcão único para indivíduos e equipas encontrarem ferramentas que ampliem e melhorem a experiência.

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

Requisitos de publicação

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

• Instale a ferramenta de empacotamento de extensão (TFX). Execute npm install -g tfx-cli a partir de um prompt de comando.
• Certifique-se de que as permissões adequadas são concedidas para usar quaisquer imagens, por exemplo, ícones, logotipos, capturas de tela e assim por diante.
• Inclua um ficheiro completo overview.md para descrever o seu anúncio no Marketplace.
• Inclua um ícone para sua extensão, que tem pelo menos 128x128 pixels de tamanho.
• Quando você se refere a produtos da Microsoft, use nomes completos no lugar de abreviaturas, por exemplo, Azure DevOps vs. AzDO ou - qualquer outra abreviação.
• Abster-se de usar nomes de marcas no nome da sua extensão.

Do que precisa

1. Logótipo de 128x128 píxeis (formato PNG ou JPEG) que representa a sua integração, você próprio ou a sua empresa/organização
2. Mínimo de uma captura de tela mostrando sua integração
3. Call to action / URL de introdução (onde os usuários devem ir para começar a sua integração)

Passos

A publicação no Marketplace é um processo iterativo que começa com a criação de um arquivo de manifesto que define sua integração e as principais características de descoberta (como capturas de tela, logotipos e conteúdo de visão geral). Estas informações são utilizadas para apresentar a sua integração aos utilizadores no Marketplace, por exemplo:

Jenkins para Azure DevOps

Nota: O termo, extension, é usado nas documentações mencionadas abaixo. As extensões são outro tipo de item do Marketplace e compartilham muitas semelhanças do ponto de vista da descoberta como integrações.

Criar um editor

Todas as extensões e integrações, incluindo extensões da Microsoft, têm um editor. Qualquer pessoa pode criar um editor e publicar extensões sob ele. Você também pode dar a outras pessoas acesso ao seu editor se uma equipe estiver desenvolvendo a extensão.

Um usuário é o proprietário do editor, normalmente o usuário que o criou. Você também pode compartilhar o editor com outros usuários.

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

2. Se ainda não for membro de um editor existente, + Criar um editor. Insira um nome no campo Nome do editor. O campo ID deve ser definido automaticamente com base no nome que você inseriu.

   

   Nota

   Anote o ID, pois você precisa defini-lo no arquivo de manifesto da sua extensão.

   Se você não for solicitado a criar um editor, role para baixo até a parte inferior da página e selecione Publicar extensões abaixo de Sites relacionados.

   • Especifique um identificador para o editor, por exemplo: mycompany-myteam. Esse identificador é usado como o valor para o atributo em seu arquivo de manifesto publisher de extensão.
   • Especifique um nome para exibição para seu editor, por exemplo: My Team

3. Reveja o Contrato de Editor do Marketplace e, em seguida, selecione Criar.

   

Depois que o editor é criado, você é direcionado para gerenciar itens, mas não há itens.

Criar uma pasta para conter o manifesto do item e outros ativos

Antes de empacotar sua integração como uma extensão, você precisará criar uma home pasta para conter alguns ativos necessários, dentro desta pasta:

1. Crie uma pasta chamada images para conter:
   • Logótipo para a sua integração (128x128 pixels)
   • Imagens (1366x768 pixels)
2. Criar um arquivo chamado overview.md
   • Descreva a sua integração aqui
   • Para saber mais sobre Markdown, consulte GitHub Flavored Markdown
3. Criar um arquivo chamado vss-integration.json
   • Este ficheiro é o ficheiro de manifesto do seu anúncio do Marketplace, contém muitas propriedades para descrever a sua extensão no seu anúncio do Marketplace. Você pode navegar pela referência do manifesto de extensão aqui

Manifesto de extensão

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 a seguinte referência:

Estas propriedades são necessárias:

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

Página Detalhes

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

Empacote seu manifesto e ativos

Obter a ferramenta de pacote (tfx-cli)

Você pode instalar ou atualizar a CLI de plataforma cruzada para DevOps do Azure (tfx-cli) usando npmo , um componente do Node.js, na sua linha de comando.

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 for empacotada, você poderá carregá-la no Marketplace sob um editor. O publisher identificador 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 gerenciamento, selecione 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 e não pode ser instalada até que você a compartilhe.

Partilhe a sua integração

Antes de instalar uma integração em uma organização no Azure DevOps ou TFS, você deve compartilhá-la com essa organização. O compartilhamento é um requisito durante o desenvolvimento e teste de uma integração, pois é a única maneira de executar uma integração.

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

1. Selecione 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 para a organização dev.azure.com/fabrikam-fiber-inc , especifique fabrikam-fiber-inc.

Atualizar um item

Para alterar uma extensão já publicada, atualize-a.

1. Selecione uma extensão na lista de itens exibidos.
2. Clique com o botão direito do mouse e selecione Atualizar para o publisher.extension-dev, por exemplo.
3. Valide a sua extensão.
4. Faça as mesmas atualizações para a versão de produção, publisher.extensionpor exemplo.
5. Navegue até o .vsix para sua extensão e carregue-a.

A versão atualizada da sua extensão é instalada automaticamente nas contas que já a têm instalada. Novas contas onde a extensão é instalada no futuro também recebem a versão mais recente.

Torne a sua integração pública (visível para todos)

Para obter informações sobre como tornar a sua integração pública, visite Tornar o seu anúncio público.