Compartilhar via


definição resources.repositories.repository

A palavra-chave repository permite especificar um repositório externo. Use um recurso de repositório para fazer referência a um repositório adicional em seu pipeline.

repositories:
- repository: string # Required as first property. Alias for the repository.
  endpoint: string # ID of the service endpoint connecting to this repository.
  trigger: none | trigger | [ string ] # CI trigger for this repository, no CI trigger if skipped (only works for Azure Repos).
  name: string # repository name (format depends on 'type'; does not accept variables).
  ref: string # ref name to checkout; defaults to 'refs/heads/main'. The branch checked out by default whenever the resource trigger fires.
  type: string # Type of repository: git, github, githubenterprise, and bitbucket.
repositories:
- repository: string # Required as first property. Alias for the repository.
  endpoint: string # ID of the service endpoint connecting to this repository.
  trigger: none | trigger | [ string ] # CI trigger for this repository, no CI trigger if skipped (only works for Azure Repos).
  name: string # repository name (format depends on 'type'; does not accept variables).
  type: string # Type of repository: git, github, githubenterprise, and bitbucket.
  ref: string # ref name to checkout; defaults to 'refs/heads/main'. The branch checked out by default whenever the resource trigger fires. Does not accept variables.
repositories:
- repository: string # Required as first property. Alias for the repository.
  endpoint: string # ID of the service endpoint connecting to this repository.
  name: string # repository name (format depends on 'type'; does not accept variables).
  type: string # Type of repository: git, github, githubenterprise, and bitbucket.
  ref: string # ref name to checkout; defaults to 'refs/heads/main'. The branch checked out by default whenever the resource trigger fires. Does not accept variables.

Definições que fazem referência a essa definição: resources.repositories

Propriedades

repository String. Obrigatório como primeira propriedade.
Alias para o repositório especificado. Valores aceitáveis: [-_A-Za-z0-9]*.

endpoint String.
ID do ponto de extremidade de serviço que se conecta a esse repositório.

triggergatilho.
Gatilho de CI para esse repositório, nenhum gatilho de CI se omitido.

Importante

  • Os gatilhos de recursos do repositório têm suporte apenas para Azure Repos repositórios Git.
  • Os gatilhos de recursos do repositório não dão suporte batcha .

name String.
Nome do repositório. O formato depende de 'type'; não aceita variáveis.

ref String.
nome do ref para check-out; usa como padrão 'refs/heads/main'. O branch faz check-out por padrão sempre que o gatilho de recurso é acionado. Há suporte para expressões de modelo.

ref String.
nome do ref para check-out; usa como padrão 'refs/heads/main'. O branch faz check-out por padrão sempre que o gatilho de recurso é acionado. Não aceita variáveis.

type String.
Tipo de repositório: git, github, githubenterprise e bitbucket.

Comentários

Importante

O recurso de repositório não permite variáveis de pipeline no e refno name . Curingas têm suporte em gatilhos.

Há suporte para expressões de modelo para a ref propriedade (mas não para a name propriedade). Curingas têm suporte em gatilhos.

Importante

Os gatilhos de recursos do repositório têm suporte apenas para Azure Repos repositórios Git. Para obter mais informações sobre trigger sintaxe, incluindo suporte a caracteres curinga para branches e marcas, consulte Definição de gatilho e Compilar Azure Repos repositórios Git ou TFS Git.

Importante

batch não é compatível com gatilhos de recursos do repositório.

Se o pipeline tiver modelos em outro repositório, você deverá informar o sistema sobre esse repositório.

Se o pipeline tiver modelos em outro repositório ou se você quiser usar o check-out de vários repositórios com um repositório que exija uma conexão de serviço, informe o sistema sobre esse repositório.

Tipos

Os pipelines dão suporte aos seguintes valores para o tipo de repositório: git, github e bitbucket. O tipo git refere-se aos repositórios Git do Azure Repos.

  • Se você especificar type: git, o name valor se refere ao nome de um Azure Repos repositório Git.

    • Se o pipeline estiver no mesmo projeto do Azure DevOps que o repositório, por exemplo, um repositório chamado tools, você o referencia usando name: tools.
    • Se o pipeline estiver na mesma organização do Azure DevOps que o repositório, mas em um projeto diferente do Azure DevOps, por exemplo, um projeto chamado ToolsProject, você deverá qualificar o nome do repositório com o nome do projeto: name: ToolsProject/tools.
  • Se você especificar type: github, o valor name é o nome completo do repositório GitHub e inclui o usuário ou a organização. Um exemplo é name: Microsoft/vscode. Os repositórios GitHub exigem uma conexão de serviço do GitHub para autorização.

  • Se você especificar type: bitbucket, o valor name é o nome completo do repositório Bitbucket Cloud e inclui o usuário ou a organização. Um exemplo é name: MyBitbucket/vscode. Os repositórios Bitbucket Cloud exigem uma conexão de serviço do Bitbucket Cloud para autorização.

Para obter mais informações sobre esses tipos, consulte Confira vários repositórios em seu pipeline – definição de recursos do repositório.

Variáveis

Em cada execução, os metadados de um recurso de repositório estão disponíveis para todos os trabalhos na forma de variáveis de tempo de execução. O <Alias> é o identificador que você forneceu para o recurso do repositório.

resources.repositories.<Alias>.name
resources.repositories.<Alias>.ref
resources.repositories.<Alias>.type
resources.repositories.<Alias>.id
resources.repositories.<Alias>.url
resources.repositories.<Alias>.version

O exemplo a seguir tem um recurso de repositório com um alias de common, e as variáveis do recurso de repositório são acessadas usando resources.repositories.common.*.

resources:
  repositories:
    - repository: common
      type: git
      ref: main
      name: Repo

variables:
  ref: $[ resources.repositories.common.ref ]
  name: $[ resources.repositories.common.name ]
  id: $[ resources.repositories.common.id ]
  type: $[ resources.repositories.common.type ]
  url: $[ resources.repositories.common.url ]
  version: $[ resources.repositories.common.version ]

steps:
- bash: |
    echo "name = $(name)"
    echo "ref = $(ref)"
    echo "id = $(id)"
    echo "type = $(type)"
    echo "url = $(url)"
    echo "version = $(version)"

Variáveis

Em cada execução, os metadados de um recurso de repositório estão disponíveis para todos os trabalhos na forma de variáveis de tempo de execução. O <Alias> é o identificador que você forneceu para o recurso do repositório.

resources.repositories.<Alias>.name
resources.repositories.<Alias>.ref
resources.repositories.<Alias>.type
resources.repositories.<Alias>.id
resources.repositories.<Alias>.url

O exemplo a seguir tem um recurso de repositório com um alias de common, e as variáveis do recurso de repositório são acessadas usando resources.repositories.common.*.

resources:
  repositories:
    - repository: common
      type: git
      ref: main
      name: Repo

variables:
  ref: $[ resources.repositories.common.ref ]
  name: $[ resources.repositories.common.name ]
  id: $[ resources.repositories.common.id ]
  type: $[ resources.repositories.common.type ]
  url: $[ resources.repositories.common.url ]

steps:
- bash: |
    echo "name = $(name)"
    echo "ref = $(ref)"
    echo "id = $(id)"
    echo "type = $(type)"
    echo "url = $(url)"

Exemplos

resources:
  repositories:
  - repository: common
    type: github
    name: Contoso/CommonTools
    endpoint: MyContosoServiceConnection

Confira também