Comandos de pull request
Origin está disponível atualmente em beta inicial. Você pode criar repositórios, fazer push e pull com o Git, espelhar repositórios do GitHub, navegar e pesquisar código, abrir e mergear pull requests e compartilhar com sua equipe do Cherri Code.
Envie qualquer feedback para [email protected] para nos ajudar a melhorar o produto.
Todos os subcomandos de origin pr e suas opções. Para os demais comandos da CLI, consulte Comandos. Para saber como os pull requests funcionam no Origin, consulte Pull requests.
Especificar uma pull request
Os comandos de pull request identificam o repositório com base no remote do Git origin do checkout atual. Substitua-o por -R, --repo no formato org/name.
A maioria dos subcomandos aceita um [target] opcional. Um número seleciona essa pull request; qualquer outro valor é interpretado como um nome de branch. Se ele for omitido, a CLI usará a pull request aberta ou em rascunho da branch atual:
origin pr view 13 # pull request 13origin pr view my-branch # pull request da branch my-branchorigin pr view # pull request da branch atualSubcomandos
| Subcomando | Descrição | Uso | |
|---|---|---|---|
create | Abrir um pull request em um repositório do Origin | origin pr create -t "Fix CI" | |
list | ls | Listar pull requests em um repositório | origin pr list |
status | Mostrar os pull requests relevantes para você em um repositório | origin pr status | |
view [target] | Exibir um pull request e, opcionalmente, seu diff, verificações ou comentários | origin pr view 13 | |
diff [target] | Ver o diff de um pull request | origin pr diff | |
checks [target] | Mostrar o status de CI de um pull request | origin pr checks | |
checkout [target] | Consultar e fazer checkout da branch do pull request | origin pr checkout 13 | |
edit [target] | Editar o título, o corpo ou a branch base | origin pr edit -t "New title" | |
ready [target] | Marcar um rascunho como pronto para revisão | origin pr ready | |
review [target] | Adicionar uma revisão | origin pr review --approve | |
comment [target] | Adicionar um comentário na discussão | origin pr comment -b "LGTM" | |
thread | Listar, resolver, reabrir e responder a threads de revisão | origin pr thread list | |
merge [target] | Mergear um pull request | origin pr merge | |
close [target] | Fechar um pull request | origin pr close | |
reopen [target] | Reabrir um pull request fechado | origin pr reopen | |
refresh [target] | Criar um snapshot de uma nova versão a partir das referências do Git atuais | origin pr refresh |
Fazer push para a branch head cria automaticamente um snapshot de uma nova versão. Execute origin pr refresh apenas quando origin pr view ou origin pr checks ainda informarem o commit head anterior. Ele não faz nada quando os commits resolvidos já correspondem à versão mais recente.
origin pr review registra uma revisão formal. origin pr comment adiciona um comentário na discussão. origin pr view --comments lista ambos.
Criar
| Opção | Descrição |
|---|---|
-t, --title <title> | Título da pull request |
-b, --body <body> | Corpo da pull request |
--description <text> | Descrição da pull request |
-F, --body-file <path> | Lê o corpo de um arquivo. Use - para a entrada padrão |
-H, --head <branch> | Branch que contém seus commits (padrão: branch atual) |
-B, --base <branch> | Branch na qual você quer mergear seu código (padrão: branch padrão do repositório) |
--push | Faz push da branch head sem solicitar confirmação se ela ainda não estiver no remoto |
--remote <remote> | remote para o qual fazer push se a branch head não estiver no remote (padrão: origin) |
--status <status> | Status inicial: draft ou open (padrão: draft) |
-d, --draft | Cria como draft. Alias de --status draft |
-f, --fill | Usa informações dos commits para o título e o corpo |
--fill-first | Usa as informações do primeiro commit para o título e o corpo |
Lista e status
| Comando | Opção | Descrição |
|---|---|---|
list | -s, --state <state> | Filtra por estado: open, closed, merged, draft ou all (padrão: open) |
list | --mine | Mostra apenas pull requests de sua autoria |
list | -B, --base <branch> | Filtra pela branch base |
list | -H, --head <branch> | Filtra pela branch head |
list | --file <path> | Filtra por um caminho alterado. Pode ser repetido; uma / no final corresponde a um prefixo de pasta |
list | -L, --limit <number> | Número máximo de itens a consultar (padrão: 30) |
list | --json <fields> | Gera JSON com os campos especificados, por exemplo, number,title,status |
list | -q, --jq <expression> | Filtra a saída JSON com uma expressão jq. Requer --json |
status | -c, --conflict-status | Mostra o status de conflito de merge de cada pull request |
Visualizar, diff e verificações
| Comando | Opção | Descrição |
|---|---|---|
view | --diff | Mostra o diff do patch coletado para a versão selecionada |
view | --checks | Inclui o resumo de mergeabilidade e CI |
view | -c, --comments | Mostra comentários e revisões, com o status de resolução de cada thread |
view | --name-only | Com --diff, imprime apenas os caminhos dos arquivos alterados |
view | --exclude <glob> | Exclui caminhos que correspondem a um glob. Pode ser repetida |
view | -w, --web | Abre a pull request no navegador |
view | --change-version <number> | Versão a exibir (padrão: mais recente) |
view | --json <fields> | Gera JSON com os campos informados. --json sem argumentos lista os campos |
view | -q, --jq <expression> | Filtra a saída JSON com uma expressão jq. Requer --json |
diff | --patch | Exibe o diff no formato de patch |
diff | --name-only | Imprime apenas os caminhos dos arquivos alterados |
diff | -e, --exclude <glob> | Exclui arquivos que correspondem a um glob. Pode ser repetida |
checks | --watch | Acompanha as verificações até serem concluídas |
checks | --json <fields> | Gera JSON com os campos informados |
checks | -q, --jq <expression> | Filtra a saída JSON com uma expressão jq. Requer --json |
list, status, view, diff e checks também aceitam --color <always|never|auto> (padrão: auto).
--diff, --checks e --comments afetam apenas a saída de texto simples de origin pr view. Para JSON, solicite os campos desejados, como files, mergeability, ciState, comments ou threads.
Checkout, edição e ciclo de vida
| Comando | Opção | Descrição |
|---|---|---|
checkout | -b, --branch <name> | Nome da branch local a usar (padrão: a ref head da pull request) |
checkout | --detach | Fazer checkout com HEAD desanexada |
checkout | -f, --force | Redefinir a branch local existente para o estado mais recente |
checkout | --remote <remote> | Remote de onde consultar (padrão: origin) |
edit | -t, --title <title> | Definir um novo título |
edit | -b, --body <body> | Definir um novo corpo |
edit | -F, --body-file <path> | Ler o novo corpo de um arquivo. Use - para stdin |
edit | -B, --base <branch> | Alterar a branch base |
ready | --undo | Converter a pull request novamente em rascunho |
merge | --auto | Mergear quando os requisitos forem atendidos e retornar |
merge | --disable-auto | Desativar o merge automático para esta pull request |
close | -c, --comment <body> | Deixar um comentário de encerramento |
reopen | -c, --comment <body> | Adicionar um comentário de reabertura |
Revisar e comentar
| Comando | Opção | Descrição |
|---|---|---|
review | -a, --approve | Aprovar o pull request |
review | -c, --comment | Enviar a revisão como comentário |
review | -b, --body <body> | Corpo da revisão |
review | -F, --body-file <path> | Ler o corpo da revisão de um arquivo. Use - para stdin |
review | --change-version <number> | Versão em revisão (padrão: mais recente) |
comment | -b, --body <body> | Corpo do comentário |
comment | -F, --body-file <path> | Ler o corpo do comentário de um arquivo. Use - para stdin |
Threads de revisão
Todo comentário de revisão pertence a uma thread com seu próprio status de resolução.
| Subcomando | Descrição | Uso |
|---|---|---|
thread list [target] | Lista as threads e seus status de resolução | origin pr thread list --unresolved |
thread resolve <thread-id> [target] | Resolve uma thread | origin pr thread resolve t_123 |
thread reopen <thread-id> [target] | Reabre uma thread resolvida | origin pr thread reopen t_123 |
thread reply <thread-id> [target] | Adiciona um comentário a uma thread | origin pr thread reply t_123 -b "Fixed" |
| Comando | Opção | Descrição |
|---|---|---|
list | --unresolved | Mostra apenas threads não resolvidas |
list | -c, --comments | Exibe o corpo de cada comentário em vez do trecho inicial |
list | --change-version <number> | Apenas threads registradas nesta versão (padrão: todas as versões) |
list | --json <fields> | Gera JSON com os campos especificados, por exemplo, id,resolved,path |
list | -q, --jq <expression> | Filtra a saída JSON com uma expressão jq. Requer --json |
reply | -b, --body <body> | Texto da resposta |
reply | -F, --body-file <path> | Lê o texto da resposta de um arquivo. Use - para stdin |
Scripts que verificam se "todas as threads foram resolvidas" podem usar origin pr thread list --unresolved --json id --jq length.
Como obter ajuda
Todos os subcomandos aceitam --help:
origin pr --helporigin pr create --helporigin pr thread --help