Criar um consumidor personalizado para ganchos de serviço

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

Use ganchos de serviço para notificar sistemas que não são da Microsoft sobre eventos que ocorrem em seu projeto. Um consumidor personalizado envia uma mensagem HTTP para o endpoint definido no manifesto da extensão.

Este artigo explica como desenvolver uma extensão que implementa um serviço de consumidor de exemplo, que inclui os seguintes eventos e ações.

• Eventos com suporte que disparam as seguintes ações:
  • Código enviado por push
  • Solicitação de pull criada
  • Solicitação de pull atualizada
• Ações com suporte a serem executadas quando ocorrerem eventos:
  • Enviar uma mensagem HTTP

Para obter mais informações, consulte o repositório GitHub de exemplo de extensão. Para obter uma lista de todos os eventos com suporte que você pode usar como gatilhos para sua extensão de consumidor personalizada, consulte Lista de tipos de eventos.

Como funcionam os ganchos de serviço

Os editores de gancho de serviço definem um conjunto de eventos. As assinaturas escutam os eventos e definem ações que são executadas quando um evento é acionado.

Este diagrama mostra o fluxo geral do gancho de serviço: os editores emitem eventos, as assinaturas correspondem aos eventos e as ações são executadas quando ocorre uma correspondência. No exemplo deste artigo, uma extensão implementa o consumidor. Quando ocorre um evento apoiado, a ação configurada do consumidor envia uma mensagem HTTP para o ponto de extremidade especificado no manifesto da extensão.

Criar a extensão

1. Veja como criar sua extensão do zero.

2. Adicione a contribuição específica para a implementação personalizada do consumidor ao arquivo de manifesto básico. Veja o exemplo a seguir de como seu manifesto deve ficar depois de adicionar a contribuição.

{
    "manifestVersion": 1,
    "id": "samples-service-hooks-consumer",
    "version": "0.1.2",
    "name": "Service Hooks Sample",
    "description": "A simple extension that demonstrates how to contribute a consumer service into service hooks.",
    "publisher": "fabrikam",
    "public": false,
    "icons": {
        "default": "images/logo.png"
    },
    "scopes": [],
    "files": [
        {
            "path": "images",
            "addressable": true
        }
    ],
    "content": {
        "details": {
            "path": "readme.md"
        }
    },
    "categories": [
        "Developer samples"
    ],
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ],
    "contributions": [
        {
            "id": "consumer",
            "type": "ms.vss-servicehooks.consumer",
            "targets": [
                "ms.vss-servicehooks.consumers"
            ],
            "properties": {
                "id": "consumer",
                "name": "Sample Consumer",
                "description": "Sample consumer service",
                "informationUrl": "https://aka.ms/vsoextensions",
                "inputDescriptors": [
                    {
                        "id": "url",
                        "isRequired": true,
                        "name": "URL",
                        "description": "URL to post event payload to",
                        "inputMode": "textbox"
                    }
                ],
                "actions": [
                    {
                        "id": "performAction",
                        "name": "Perform action",
                        "description": "Posts a standard event payload",
                        "supportedEventTypes": [
                            "git.push",
                            "git.pullrequest.created",
                            "git.pullrequest.updated"
                        ],
                        "publishEvent": {
                            "url": "{{{url}}}",
                            "resourceDetailsToSend": "all",
                            "messagesToSend": "all",
                            "detailedMessagesToSend": "all"
                        }
                    }
                ]
            }
        }
    ]
}

Para cada contribuição em sua extensão, o manifesto define os itens a seguir.

• Tipo de contribuição – serviço do consumidor (ms.vss-servicehooks.consumer) nesse caso.
• Destino de contribuição – serviços ao consumidor (ms.vss-servicehooks.consumers) nesse caso.
• Propriedades específicas para cada tipo de contribuição.

Os consumidores têm as propriedades a seguir.

As ações para o consumidor têm as seguintes propriedades:

3. Implante sua extensão em sua organização do Azure DevOps e teste-a.

Próximas etapas

Conteúdo relacionado

• Consumidores de hook de serviço
• Serviços disponíveis para ganchos de serviço
• Criar uma assinatura de hook de serviço programaticamente
• Testar e depurar extensões no navegador
• Exemplo de extensão do repositório GitHub
• Lista de tipos de eventos