Compartilhar via


definição de 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: git | github | githubenterprise | bitbucket # 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).
  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.

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

Propriedades

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

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

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

Importante

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

name cadeia de caracteres.
nome do repositório. O formato depende do 'tipo'; não aceita variáveis.

ref cadeia de caracteres.
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. Expressões de modelo têm suporte.

ref cadeia de caracteres.
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 cadeia de caracteres.
tipo de repositório: git, github, githubenterprise e bitbucket.

Observações

Importante

O recurso de repositório não permite variáveis de pipeline em name e ref. Há suporte para curingas em gatilhos.

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

Importante

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

Importante

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

Se o pipeline tiver modelos de em outrode repositório ou se você quiser usar 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, githube bitbucket. O tipo de git refere-se aos repositórios Git do Azure Repos.

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

    • Se o pipeline estiver no mesmo projeto do Azure DevOps que o repositório, por exemplo, um repositório chamado tools, faça referência a ele 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 será o nome completo do repositório GitHub e incluirá o usuário ou a organização. Um exemplo é name: Microsoft/vscode. Os repositórios do GitHub exigem um de conexão de serviço do GitHub para autorização.

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

Para obter mais informações sobre esses tipos, consulte Confira vários repositórios em seu pipeline – definição de recurso de 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 runtime. O <Alias> é o identificador que você forneceu para o recurso de 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 commone as variáveis de recurso do 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 runtime. O <Alias> é o identificador que você forneceu para o recurso de 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 commone as variáveis de recurso do 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

Consulte também