Empacotar e publicar uma integração

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

Publique a sua ferramenta, serviço ou produto que se integre com o Azure DevOps no Visual Studio Marketplace. O Marketplace é o ponto central para os utilizadores descobrirem integrações e extensões.

Pré-requisitos

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

Também precisa dos seguintes ativos:

• Pelo menos uma captura de ecrã da tua integração
• Um URL de chamada à ação ou de início para utilizadores

Criar uma editora

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.

Estruturar a estrutura do projeto

Crie o seguinte layout de diretório:

home/
├── images/
│   ├── integration-logo.png    (128×128 px minimum)
│   └── screenshot.png          (1366×768 px)
├── overview.md
└── vss-integration.json

Criar o manifesto

Crie vss-integration.json com o seguinte conteúdo e depois atualize os valores para a sua integração:

{
    "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"
    }
}

Atualizar campos 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:

Empacotar a integração

1. Instale a ferramenta de embalagem se ainda não o fez:

   npm install -g tfx-cli
   

2. Empacota a tua integração num ficheiro .vsix:

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

   Sugestão

   Use --rev-version para incrementar automaticamente o número da versão do patch.

Publicar 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 integração

Antes de poder instalar uma integração numa organização Azure DevOps, deve partilhá-la com essa organização.

1. Selecione a sua integração da lista de itens apresentados.
2. Selecione Partilhar.
3. Insira o nome da organização (por exemplo, fabrikam-fiber-inc para dev.azure.com/fabrikam-fiber-inc).

Atualizar a integração

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.

Tornar a integração pública

Para tornar a sua integração visível para todos os utilizadores do Marketplace, defina o public flag para true no seu manifesto e republique.

Para mais informações sobre as qualificações exigidas para as listagens públicas, consulte Tornar a sua extensão pública.

Conteúdo relacionado

• Referência do manifesto de extensão
• Empacotar e publicar extensões
• Mercado do Visual Studio