Skip to main content

Usar parâmetros de consulta para criar um pull request

Usar parâmetros de consulta para criar URLs personalizadas para abrir pull requests com campos pré-preenchidos.

Você pode usar parâmetros de consulta para abrir pull requests. Os parâmetros de consulta são partes opcionais de uma URL que você pode personalizar para compartilhar uma visualização específica da página, tais como resultados de filtro de pesquisa ou um modelo de pull request em GitHub. Para criar seus próprios parâmetros de consulta, você deve corresponder o par de chave e valor.

Tip

Você também pode criar modelos de pull request que são abertos com rótulos padrão, destinatários e um título de pull request. Para obter mais informações, confira "Usando modelos para incentivar problemas úteis e receber pull request".

Você deve ter as permissões adequadas para qualquer ação para usar o parâmetro de consulta equivalente. Por exemplo, você precisa ter permissão para adicionar um rótulo a uma solicitação de pull para usar o parâmetro de consulta labels. Para obter mais informações, confira "Funções de repositório para uma organização".

Se você criar uma URL inválida usando parâmetros de consulta ou se não tiver as permissões adequadas, a URL retornará uma página de erro 404 Not Found. Se você criar uma URL que exceda o limite do servidor, a URL retornará uma página de erro 414 URI Too Long.

Parâmetro de consultaExemplo
quick_pullhttps://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1 cria uma solicitação de pull que compara o branch base main com o branch principal my-branch. A consulta quick_pull=1 leva você diretamente para a página "Abrir uma solicitação de pull".
titlehttps://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&labels=bug&title=Bug+fix cria uma solicitação de pull com o rótulo "bug" e o título "Correção de bug".
bodyhttps://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&title=Bug+fix&body=Describe+the+fix. cria uma solicitação de pull com o título "Correção de bug" e o comentário "Descreva a correção" no corpo da solicitação de pull.
labelshttps://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&labels=help+wanted,bug cria uma solicitação de pull com os rótulos "preciso de ajuda" e "bug".
milestonehttps://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&milestone=testing+milestones cria uma solicitação de pull com o marco "testando marcos".
assigneeshttps://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&assignees=octocat cria uma solicitação de pull e a atribui a @octocat.
projectshttps://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&title=Bug+fix&projects=octo-org/1 cria uma solicitação de pull com o título "Correção de bug" e a adiciona ao projeto 1 da organização.
templatehttps://github.com/octo-org/octo-repo/compare/main...my-branch?quick_pull=1&template=issue_template.md cria uma solicitação de pull com um modelo no corpo da solicitação de pull. O parâmetro de consulta template funciona com modelos armazenados em um subdiretório PULL_REQUEST_TEMPLATE na raiz, o diretório docs/ ou .github/ de um repositório. Para obter mais informações, confira "Usando modelos para incentivar problemas úteis e receber pull request".