pr definition

Um gatilho de solicitação de pull especifica quais branches fazem com que um build de solicitação de pull seja executado.

Definições que fazem referência a essa definição: pipeline

Implementações

Implementação	Descrição
pr: nenhum	Desabilitar gatilhos de solicitação de pull.
pr: lista de cadeias de caracteres	Lista de branches que disparam uma execução.
pr: autoCancel, branches, caminhos, rascunhos	Sintaxe completa para controle completo.

Comentários

Se você não especificar um gatilho de solicitação de pull, as solicitações de pull para qualquer branch dispararão um build.

Há três opções de sintaxe diferentes para a palavra-chave pr: uma lista de branches a serem incluídos, uma maneira de desabilitar gatilhos de PR e a sintaxe completa para controle completo.

Importante

Há suporte para gatilhos de PR do YAML apenas no GitHub e no Bitbucket Cloud. Se você usar o Azure Repos Git, poderá configurar uma política de branch para validação de build para disparar o pipeline de build para validação.

Se você especificar uma cláusula exclude sem uma cláusula include para branches ou paths, isso será equivalente a especificar * na cláusula include.

pr: nenhum

Desabilitar gatilhos de solicitação de pull.

pr: none # Disable pull request triggers.

pr String. Valores permitidos: nenhum.

Desabilitar gatilhos de solicitação de pull.

Exemplos

Sintaxe de desabilitação:

pr: none # will disable PR builds (but not CI builds)

pr: lista de cadeias de caracteres

Lista de branches que disparam uma execução.

pr: [ string ] # List of branches that trigger a run.

Tipos de lista

Tipo	Descrição
string	Lista de branches que disparam uma execução.

Comentários

A sintaxe de lista especifica uma lista de branches que disparam uma execução quando uma solicitação de pull é gerada ou um push é feito para o branch de origem de uma solicitação de pull gerada.

Exemplos

Sintaxe de lista:

pr:
- main
- develop

pr: autoCancel, branches, caminhos, rascunhos

Use a sintaxe completa quando precisar de controle total do gatilho de solicitação de pull.

pr:
  autoCancel: boolean # Whether to cancel running PR builds when a new commit lands in the branch. Default: true.
  branches: # Branch names to include or exclude for triggering a run.
    include: [ string ] # List of items to include.
    exclude: [ string ] # List of items to exclude.
  paths: # File paths to include or exclude for triggering a run.
    include: [ string ] # List of items to include.
    exclude: [ string ] # List of items to exclude.
  drafts: boolean # Whether to start a run when a draft PR is created. Default: true.

Propriedades

autoCancelbooliano.
Se a execução de builds de PR deve ser cancelada quando um novo commit chega ao branch. Padrão: true.

branchesincludeExcludeFilters.
Nomes de branch a serem incluídos ou excluídos para disparar uma execução.

pathsincludeExcludeFilters.
Caminhos de arquivo a serem incluídos ou excluídos para disparar uma execução.

draftsbooliano.
Se uma execução deve ser iniciada quando um rascunho de PR é criado. Padrão: true.

Exemplos

Sintaxe completa:

pr:
  branches:
    include:
    - features/*
    exclude:
    - features/experimental/*
  paths:
    exclude:
    - README.md

Confira também

Saiba mais sobre gatilhos de solicitação de pull e como especificá-los.