Como mesclar uma solicitação de pull com uma fila de mesclagem

Neste artigo

Se uma fila de mesclagem for exigida pela configuração de proteção do branch, você poderá adicionar as solicitações de pull a uma fila de mesclagem para que o GitHub mescle as solicitações de pull depois que todas as verificações necessárias forem aprovadas.

Tool navigation

As filas de mesclagem de solicitação de pull estão disponíveis em qualquer repositório público pertencente a uma organização ou em repositórios privados pertencentes a organizações que usam GitHub Enterprise Cloud. Para mais informações, confira "Planos do GitHub".

Sobre as filas de mesclagem

Uma fila de mesclagem ajuda a aumentar a velocidade automatizando mesclagens de solicitação de pull em um branch ocupado e garantindo que o branch nunca seja interrompido por alterações incompatíveis.

A fila de mesclagem oferece os mesmos benefícios que a proteção de branch Exigir que os branches sejam atualizados antes da mesclagem, mas não exige que o autor da solicitação de pull atualize o branch de solicitação de pull e aguarde a conclusão das verificações de status para tentar a mesclagem.

O uso de uma fila de mesclagem é útil principalmente em branches que têm um número relativamente alto de solicitações de pull de vários usuários diferentes sendo mescladas todos os dias.

Depois que uma solicitação de pull é aprovada em todas as verificações de proteção de branch necessárias, o usuário com acesso de gravação no repositório pode adicioná-la a uma fila de mesclagem. A fila de mesclagem garante que as alterações da solicitação de pull sejam aprovadas em todas as verificações de status necessárias quando aplicadas à versão mais recente do branch de destino e às solicitações de pull que já estão na fila.

Uma fila de mesclagem pode usar GitHub Actions ou o próprio provedor de CI para executar as verificações necessárias nas solicitações de pull em uma fila de mesclagem. Para obter mais informações, confira "Documentação do GitHub Actions".

Para obter mais informações sobre filas de mesclagem, confira "Como gerenciar uma fila de mesclagem".

Como adicionar uma solicitação de pull a uma fila de mesclagem

Observação: use a GitHub CLI para adicionar uma solicitação de pull a uma fila de mesclagem. Para obter mais informações, clique na guia "GitHub CLI" na parte superior deste artigo.

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Abaixo do nome do repositório, clique em Solicitações de pull.

    Captura de tela da página principal de um repositório. Na barra de navegação horizontal, uma guia, rotulada como "Solicitações de pull", é destacada em laranja escuro.

  3. Na lista "Solicitações de Pull", clique na solicitação de pull que deseja adicionar a uma fila de mesclagem.

  4. Clique em Mesclar quando estiver pronto para adicionar a solicitação de pull à fila de mesclagem. Como alternativa, se você for um administrador, poderá:

    • Mescle diretamente a solicitação de pull marcando Mesclar sem esperar que os requisitos sejam atendidos (ignorar proteções de branch) , se permitido pelas configurações de proteção de branch, e siga o fluxo padrão.

    Captura de tela das opções de fila de mesclagem para uma solicitação de pull.

    Observação: clique em Mesclar quando estiver pronto sempre que estiver pronto para mesclar as alterações propostas. O GitHub adicionará automaticamente a solicitação de pull à fila de mesclagem depois que as condições de aprovação e verificação de status necessárias forem atendidas.

  5. Confirme se deseja adicionar a solicitação de pull à fila de mesclagem clicando em Confirmar mesclagem quando estiver pronto.

Com GitHub CLI, você pode usar o comando gh pr merge para adicionar uma solicitação de pull a uma fila de mesclagem. Se você estiver direcionando um branch que requer uma fila de mesclagem, esse comando adicionará automaticamente a solicitação de pull à fila se as verificações necessárias tiverem passado. Se as verificações necessárias não tiverem passado, esse comando habilitará a mesclagem automática para a solicitação de pull. Para obter mais informações, confira gh pr merge no manual da GitHub CLI.

Como remover uma solicitação de pull de uma fila de mesclagem

Para remover uma solicitação de pull de uma fila de mesclagem, navegue até a página do repositório em GitHub.com. Você não pode usar GitHub CLI para remover uma solicitação de pull de uma fila de mesclagem.

  1. No GitHub.com, navegue até a página principal do repositório.

  2. Abaixo do nome do repositório, clique em Solicitações de pull.

    Captura de tela da página principal de um repositório. Na barra de navegação horizontal, uma guia, rotulada como "Solicitações de pull", é destacada em laranja escuro.

  3. Na lista "Solicitações de Pull", clique na solicitação de pull que deseja remover de uma fila de mesclagem.

  4. Para remover a solicitação de pull da fila, clique em Remover da fila.

    Captura de tela da mensagem de fila de mesclagem no final de uma solicitação de pull. O botão "Remover da fila" está contornado em laranja escuro.

Como alternativa, navegue até a página da fila de mesclagem do branch base, clique em … ao lado da solicitação de pull que deseja remover e selecionar Remover da fila. Para obter informações sobre como acessar a página de fila de mesclagem do branch base, confira a seção abaixo.

Como ver as filas de mesclagem

Você pode ver a fila de mesclagem de um branch base em vários locais no GitHub. Você não pode usar GitHub CLI para exibir uma fila de mesclagem.

Você pode ver a fila de mesclagem de um branch base em vários locais no GitHub.

  • Na página Branches do repositório. Recomendamos que você use essa rota se não tiver ou não souber que uma solicitação de pull já está em uma fila e quiser ver o que está nessa fila. Para obter mais informações, confira "Exibir branches no repositório".

    Captura de tela da página "Branches" para um repositório. Um link, rotulado "33 solicitações de pull colocadas na fila para mesclagem", está contornado em laranja escuro.

  • Na página de solicitação de pull quando a fila de mesclagem for necessária para mesclagem, role a página até a parte inferior da linha do tempo e clique no link da fila de mesclagem.

    Captura de tela da mensagem de fila de mesclagem no final de uma solicitação de pull. O link "Fila de mesclagem" está contornado em laranja escuro.

  • A exibição da fila de merge mostra os pull requests que estão atualmente na fila, com seus pull requests claramente marcados.

    Captura de tela da fila de mesclagem.

Entender por que a solicitação de pull foi removida da fila de mesclagem

Após o agrupamento de uma solicitação de pull com a última versão do branch de destino e as alterações que já estão na fila, se houver verificações de status obrigatórias com falha ou conflitos com o branch base, a solicitação de pull será removida da fila. A linha do tempo da solicitação de pull exibirá o motivo pelo qual ela foi removida da fila.

Há vários motivos pelos quais uma solicitação de pull pode ser removida de uma fila de mesclagem:

  • O serviço de CI configurado está relatando falhas de teste de um grupo de mesclagem
  • Tempo limite atingido aguardando um resultado de CI bem-sucedido com base na configuração de tempo limite definida
  • Usuário solicitando uma remoção por meio da API ou interface da fila de mesclagem
  • Falha de proteção de branch que não pôde ser resolvida automaticamente