Pular para o conteúdo
Documentation

CHAMPREP Comandos de código

champrep code Funciona com o CodeCHAMPREP a partir do seu terminal: projetos e ramas, clonagem em massa, solicitações de mesclagem, issues, pipelines e logs de tarefas, executores de CI e lançamentos. Ele atua em seu nome, com seu CLIlogin normal, de modo que o Code aplica sua função em cada projeto, seu plano e suas cotas exatamente como o aplicativo web faz.

  1. Instale o CLI e fazer login com champrep auth login.
  2. Seu plano deve incluir CHAMPREP Code. Caso contrário, os comandos serão interrompidos com not available to your account (código de saída 1).
Terminal window
champrep auth login
champrep code projects ls

Nomeação de projetos, solicitações de mesclagem e issues

Seção intitulada “Nomeação de projetos, solicitações de mesclagem e issues”
  • PROJECT é o caminho completo do projeto, como acme/web, ou seu ID. O caminho é o mais fácil de digitar.
  • As solicitações de mesclagem e as questões são numeradas por projeto. Indique o número: 12 e !12 tanto o nome da solicitação de mesclagem 12 quanto 34 e #34 ambos o nome issue 34.
  • PIPELINE_ID e JOB_ID são os números exibidos por pipelines ls e jobs ls.

ComandoObjetivo
champrep code projects lsListe os projetos dos quais o(a) senhor(a) é membro. --search TEXT, --all (incluindo projetos públicos e internos que o senhor possa visualizar), --limit N.
champrep code projects show PROJECTExiba um projeto, seu branch padrão e seus endereços de clonagem.
champrep code projects create NAMECrie um projeto em seu namespace pessoal ou em um grupo com --namespace. Além disso --path, --visibility private|internal|public, --description, --default-branch.
champrep code repo clone-url PROJECTExiba o endereço de clonagem HTTPS (--ssh (para o endereço SSH).
champrep code clone PROJECT...Clone projetos em --dest (padrão .), cada um sob seu próprio namespace: DEST/<group>/<subgroup>/<project>.
champrep code clone --group GROUPClone todos os projetos de um grupo; --include-subgroups adiciona todos os subgrupos.
champrep code clone --membership / --owned / --allClone todos os projetos dos quais você é membro, nos quais sua função é Proprietário ou que você possa visualizar.
champrep code branches ls PROJECTListe os ramos com seu último commit. --search, --limit.
champrep code ssh-keys lsListe as chaves SSH na sua conta do Code.

code clone opções:

  • --ssh, ou --https (padrão), seleciona o protocolo.
  • --dry-run lista o que aconteceria.
  • --parallel N Executa N operações do Git de uma só vez (padrão: 4, no máximo 16).
  • --archived inclui projetos arquivados.
  • --update baixa e avança rapidamente projetos já clonados, em vez de ignorá-los. Um clone cujo origin Se for outro repositório, é relatado como mismatch. Um HEAD desanexado ou um ramo sem um upstream é relatado como no-upstream.
  • --search TEXT mantém apenas os projetos que correspondem.
  • --max-projects N Lida com, no máximo, N projetos (padrão: 1.000), contados após o --owned filtro.

Ele exibe um resumo e encerra a execução 1 quando qualquer projeto falhar ou a execução for interrompida (Ctrl-C interrompe novos clones e os que estão em execução). Com --json ele imprime uma entrada por projeto com seu status.

Uma clonagem em massa nunca solicita confirmação. O git é executado com GIT_TERMINAL_PROMPT=0, e o SSH é executado com BatchMode=yes a menos que você defina GIT_SSH_COMMAND ou core.sshCommand você mesmo. Apenas https:// e os endereços SSH no host CHAMPREP Code são clonados, e o git é executado com todos os outros meios de transporte desativados.

O git realiza a autenticação por conta própria. Utilize uma chave SSH ou um token de acesso pessoal armazenado no repositório de credenciais do git; ambos são configurados uma única vez no aplicativo web Code; consulte Configurar credenciais do Git. O CLI nunca insere um token em uma URL remota ou em .git/config.

mr também aceita merge-requests.

ComandoObjetivo
champrep code mr ls PROJECTListar solicitações de mesclagem. --state opened (padrão), merged, closed, locked ou all; --mine; --search; --limit.
champrep code mr show PROJECT IIDExiba uma solicitação de mesclagem, seu status de mesclagem e seu pipeline principal.
champrep code mr create PROJECTAbra uma solicitação de mesclagem. Requer --source, --target e --title; além disso --description, --draft, --remove-source-branch, --squash.
champrep code mr merge PROJECT IIDMesclar agora, ou com --auto quando o pipeline é bem-sucedido. Além disso --squash, --remove-source-branch, --message, --sha.
champrep code mr approve PROJECT IIDAprovar. --sha associa a aprovação ao commit que o(a) senhor(a) revisou.

ComandoObjetivo
champrep code issues ls PROJECTListar problemas. --state opened (padrão), closed ou all; --labels a,b; --search; --mine (atribuídos a você); --limit.
champrep code issues show PROJECT IIDExibir uma incidência.
champrep code issues create PROJECTCrie uma solicitação. Requer --title; além disso --description, --labels, --confidential, --due YYYY-MM-DD.
champrep code issues close PROJECT IIDFechar uma solicitação.
champrep code issues reopen PROJECT IIDReabrir uma questão encerrada.

pipelines também aceita pl.

ComandoObjetivo
champrep code pipelines ls PROJECTListar pipelines, começando pelos mais recentes. --ref, --status, --limit.
champrep code pipelines show PROJECT PIPELINE_IDExiba um pipeline e todos os trabalhos nele contidos.
champrep code pipelines run PROJECT --ref REFExecute um pipeline em um branch ou tag. --var KEY=VALUE adiciona uma variável (repetível).
champrep code pipelines retry PROJECT PIPELINE_IDRepita os trabalhos com falha e cancelados.
champrep code pipelines cancel PROJECT PIPELINE_IDCancele um pipeline em execução.
champrep code pipelines wait PROJECT [PIPELINE_ID]Aguarde a conclusão de um pipeline: o especificado, o mais recente de um commit com --sha SHA (ou --sha HEAD no repositório; ele aguarda até que o pipeline apareça), ou o mais recente em --ref BRANCH naquele momento (padrão: o branch padrão). Após um push, use --sha: --ref ainda é possível localizar o pipeline do commit anterior. Verifica com um intervalo crescente (de 5 s a 60 s); o progresso e a linha de status final são enviados para o stderr, e --json imprime o pipeline concluído. Uma tarefa agendada (adiada) mantém o processo em espera. Encerra 0 em caso de sucesso, 1 quando falhar, for cancelado ou ignorado, ou for interrompido por uma tarefa manual (--manual-ok aceita isso), e 8 quando --timeout (padrão) 60m) se esgota.
champrep code jobs ls PROJECTListar tarefas, começando pelas mais recentes, ou as tarefas de um pipeline com --pipeline ID. --status failed,running; --limit.
champrep code jobs log PROJECT JOB_IDExiba o log de uma tarefa. --tail N imprime as últimas N linhas, lidas a partir do final do log, de modo que funciona em um log de qualquer tamanho. --follow (-f) continua exibindo mensagens até que a tarefa seja concluída; a linha de encerramento “Tarefa N concluída” é enviada para o stderr, de modo que o stdout contém apenas o log, e o código de saída representa o resultado da tarefa: 0 quando for bem-sucedido, 1 quando falhou ou foi cancelado. Um log com mais de 8 MiB precisa de --tail ou --follow, que então inicia a partir de suas últimas 100 linhas.
champrep code jobs play PROJECT JOB_IDInicie um trabalho manual. --var KEY=VALUE passa uma variável de tarefa.
champrep code jobs retry PROJECT JOB_IDRepita um trabalho concluído.

runners também aceita runner.

ComandoObjetivo
champrep code runners lsListe os executores de projeto e de grupo que o(a) senhor(a) gerencia. --project PROJECT (executores que o projeto pode utilizar; Mantenedor), --group GROUP (Proprietário), --all (administradores de instância). Filtros: --status online|offline|stale|never_contacted, --paused / --active, --tag a,b, --type instance|group|project, --search, --limit.
champrep code runners show RUNNER_IDExiba o status, se está online, em pausa, tags, último contato, máquinas e projetos ou grupos atribuídos.
champrep code runners update RUNNER_ID--tags a,b substitui a lista de tags; --add-tag / --remove-tag (repetível) altere-o lendo as tags e reescrevendo a lista inteira, de modo que qualquer alteração feita por alguém nesse intervalo seja sobrescrita; --pause / --resume; --description.
champrep code runners createCrie um executador de projeto (--project, Mantenedor) ou um executor de grupo (--group, Proprietário). Além disso --description, --tags, --no-untagged, --protected, --locked, --paused. Exibe o token de autenticação do executor (ccrt_…) uma vez no stdout e nunca o registra no log. Sempre requer --yes. Alias register.

Conecte uma máquina a um novo executor com champrep-code-runner register. A redefinição de um token de executor e a criação de executores de instância permanecem no aplicativo web.

ComandoObjetivo
champrep code releases ls PROJECTListar lançamentos, começando pelos mais recentes. --limit.

As listas exibem 20 linhas por padrão. Aumente --limit (até 500) para ver mais; a CLI CLI avisa quando houver mais linhas e, nesse caso, --limit 500 ele solicita que você restrinja os filtros. jobs ls --pipeline ID --status S filtros do seu lado após ler os primeiros 500 trabalhos do pipeline e avisa quando houver mais.

Mais receitas tarefa a tarefa, com variantes de script, encontram-se em Tarefas comuns.

Clone um grupo inteiro, com seus subgrupos, e mantenha-o atualizado:

Terminal window
champrep code clone --group acme --include-subgroups --dest ~/src --ssh
champrep code clone --group acme --include-subgroups --dest ~/src --ssh --update

Clone um projeto e abra uma solicitação de mesclagem para o seu branch:

Terminal window
git clone "$(champrep code repo clone-url acme/web)"
champrep code mr create acme/web --source feature/login --target main \
--title "Add login page" --remove-source-branch --yes

Analise as solicitações de mesclagem em aberto e mescle uma quando seu pipeline for aprovado:

Terminal window
champrep code mr ls acme/web
champrep code mr show acme/web 12
champrep code mr merge acme/web 12 --auto --squash --yes

Execute um pipeline, aguarde sua conclusão e acompanhe o log de uma tarefa:

Terminal window
champrep code pipelines run acme/web --ref main --var DEPLOY=staging --yes
champrep code pipelines wait acme/web --ref main && echo "main is green"
champrep code pipelines ls acme/web --ref main --limit 5
champrep code pipelines show acme/web 9921
champrep code jobs log acme/web 4182 --follow

Encontre tarefas com falha e tente novamente uma delas:

Terminal window
champrep code jobs ls acme/web --status failed
champrep code jobs log acme/web 4180 --tail 50
champrep code jobs retry acme/web 4180 --yes

Acompanhe os problemas:

Terminal window
champrep code issues ls acme/web --labels bug --search login
champrep code issues create acme/web --title "Login fails on Safari" --labels bug,web
champrep code issues close acme/web 34 --yes

Os comandos que alteram algo importante solicitam confirmação antes de agir: mr create (abrir uma solicitação de mesclagem pode iniciar um pipeline), mr merge, mr approve, issues close e reopen, runners update, e todas as ações de pipeline e tarefa (run, retry, cancel, play), que utilizam minutos de CI. runners create sempre requer --yes, também no terminal, pois exibe uma credencial. clone altera apenas o seu disco e não solicita confirmação. No terminal, responda y. Em um script, passe --yes (-y). Sem terminal e sem --yes O comando recusa e não altera nada.

A criação de um projeto ou de uma solicitação não requer confirmação. Cria, mescla, executa pipelines, repete tentativas e cancela; além disso, as execuções de tarefas e as tentativas de repetição possuem uma chave de idempotência, de modo que CLIa repetição automática após um erro de rede nunca executa a tarefa duas vezes.

O CLI recusa um argumento de projeto, solicitação de mesclagem, issue, pipeline ou tarefa com um . ou .. segmento do caminho antes de enviar qualquer coisa.

Adicionar --json Para imprimir o código retornado: as listas exibem um array JSON de itens, pipelines show imprime { "pipeline": …, "jobs": [ … ] }.

Terminal window
champrep code mr ls acme/web --json | jq -r '.[] | "\(.iid) \(.title)"'

MensagemO que fazer
needs your web session … (SESSION_REQUIRED)Fusão ou aprovação em um ramo protegido Essa é uma decisão que somente o(a) senhor(a) pode tomar, após fazer login no aplicativo web do CodeCHAMPREP. Abra a solicitação de mesclagem no seu navegador e mescle-a ou aprove-a por lá. Os ramos desprotegidos funcionam a partir do CLI.
not allowed for your role … (MERGE_NOT_ALLOWED), (PROJECT_ARCHIVED)Sua função no projeto não permite a ação, ou o projeto está arquivado (somente leitura). Consulte um mantenedor ou proprietário.
not available to your account …Seu plano ou a política da sua organização não inclui o CodeCHAMPREP ou esse recurso. Consulte planos Ou consulte seu administrador.
quota exceeded …, payment required …A capacidade do seu plano ou os minutos de CI foram esgotados. Adicione capacidade em CHAMPREP Faturamento e, em seguida, execute o comando novamente.
not found …O projeto, a solicitação de mesclagem, a questão ou o pipeline não existe, ou o senhor não consegue visualizá-lo.
http 409 … (SHA_MISMATCH)A solicitação de mesclagem foi movida desde que o senhor a visualizou. Verifique mr show e tente novamente.

Os códigos de saída seguem o referência de comandos: cada recusa acima encerra o processo 1, incluindo --json execuções; 3 significa que você precisa fazer login novamente, 5 um limite de taxa do gateway, 6 uma falha de rede e 7 uma falha no serviço que as tentativas de repetição não conseguiram superar. pipelines wait sai 1 quando o pipeline não for bem-sucedido e 8 quando o seu --timeout esgotou; jobs log --follow sai 1 quando o trabalho falhar ou for cancelado. Tanto a espera quanto a repetição ocorrem automaticamente em caso de erros de serviço, limites de taxa e falhas de rede, e são desistidas após oito tentativas consecutivas.