Partilhar via

Modelo de contribuição

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

As extensões adicionam recursos ao Azure DevOps declarando tipos de contribuição e instâncias de contribuição. Um tipo de contribuição define um contrato (as propriedades e o comportamento) que as contribuições desse tipo devem implementar. Uma contribuição é uma instância concreta de um tipo de contribuição (por exemplo, um hub ou uma tarefa de compilação).

Sugestão

Se você estiver iniciando uma nova extensão do Azure DevOps, experimente essas coleções de exemplo mantidas primeiro — elas funcionam com compilações de produtos atuais e abrangem cenários modernos (por exemplo, adicionando guias em páginas de solicitação pull).

Se um exemplo não funcionar em sua organização, instale-o em uma organização pessoal ou de teste e compare as IDs de destino e as versões de API do manifesto de extensão com os documentos atuais. Para referência e APIs, consulte:

Para obter mais informações, consulte:

Tipos de contribuição

Um tipo de contribuição define as propriedades e as regras que as contribuições desse tipo devem seguir. Um tipo de contribuição pode estender outro tipo de contribuição, herdando suas propriedades.

Os tipos de contribuição comuns incluem:

  • hub
  • action
  • build-task

Cada definição de propriedade inclui:

  • Tipo de propriedade (por exemplo, string ou booleano)
  • se a propriedade é obrigatória
  • um valor padrão opcional

Example

Uma declaração de tipo de contribuição em um manifesto tem esta aparência:

{
  "contributionTypes": [
    {
      "id": "hub",
      "name": "Web Access Hub",
      "description": "A hub that appears in the hubs menu at the top of web pages.",
      "properties": {
        "name": {
          "description": "The text to display for the hub",
          "type": "string",
          "required": true
        },
        "uri": {
          "description": "URI of the contents of the hub page",
          "type": "string",
          "required": true
        },
        "order": {
          "description": "Optional ordering value indicating the hub's position within the hub group",
          "type": "integer"
        }
      }
    }
  ]
}

Contribuições

Uma contribuição é uma instância de um tipo de contribuição. Por exemplo, o hub Queries no grupo de trabalho Hub é uma contribuição do tipo hub, e a tarefa de compilação Publish Test Results é uma contribuição do tipo build-task.

Todas as contribuições devem especificar um tipo e valores para quaisquer propriedades exigidas por esse tipo de contribuição.

Example

Aqui está um exemplo de uma declaração de contribuição de hub num manifesto de extensão:

{
    "contributions": [
        {
            "id": "build-explorer-hub",
            "type": "ms.vss-web.hub",
            "targets": [
                ".build-hub-group"
            ],
            "properties": {
                "name": "Explorer",
                "uri": "/_build",
                "order": 22
            }
        }
    ]
}

Contribuições-alvo

Uma contribuição pode visar uma ou mais outras contribuições, criando assim uma relação entre a contribuição e cada um dos seus alvos. O sistema pode descobrir contribuições para o destino em tempo de execução. Por exemplo, uma hub contribuição (Explorer) pode ter como alvo uma contribuição específica hub-group (Build).

{
    "id": "build-explorer-hub",
    "type": "ms.vss-web.hub",
    "targets": [
        ".build-hub-group"
    ]
}

Quando o grupo de hubs é apresentado, o sistema pode consultar todas as contribuições de hubs destinadas ao grupo de hubs para saber quais hubs apresentar.

Identificar contribuições e tipos

Cada contribuição e tipo de contribuição deve ter um ID exclusivo dentro da extensão em que é declarada.

Um identificador de contribuição completo inclui os seguintes itens, que você separa com um ponto . :

  • ID do publicador
  • ID da extensão
  • ID da contribuição/tipo

Por exemplo: ms.vss-web.hub é o identificador completo da seguinte contribuição:

  • ID do editor: ms
  • ID da extensão: vss-web
  • ID da contribuição/tipo: hub

Você pode usar referências de contribuição relativa dentro de um manifesto de extensão para a referência de uma contribuição a outra contribuição ou tipo de contribuição dentro dessa mesma extensão. Nesse caso, os IDs do editor e da extensão não são incluídos, e o ID é um ponto . seguido pelo ID de contribuição. Por exemplo, .hub pode ser usado dentro da extensão vss-web mencionada anteriormente como um atalho para ms.vss-web.hub.

  • Last updated on