Ir al contenido
Documentation

CHAMPREP Comandos de código

champrep code Funciona con CHAMPREP Code desde su terminal: proyectos y ramas, clonación masiva, solicitudes de fusión, incidencias, pipelines y registros de tareas, ejecutores de CI y versiones. Actúa en su nombre, con su CLIinicio de sesión habitual, de modo que Code aplica su rol en cada proyecto, su plan y sus cuotas exactamente igual que lo hace la aplicación web.

  1. Instale el CLI y iniciar sesión con champrep auth login.
  2. Su plan debe incluir «CodeCHAMPREP». Si no es así, los comandos se detienen con not available to your account (código de salida 1).
Ventana de terminal
champrep auth login
champrep code projects ls

Nombrar proyectos, solicitudes de fusión y incidencias

Sección titulada «Nombrar proyectos, solicitudes de fusión y incidencias»
  • PROJECT es la ruta completa del proyecto, como por ejemplo acme/web, o su ID. La ruta es la forma más sencilla de escribirla.
  • Las solicitudes de fusión y las incidencias se numeran por proyecto. Indique el número: 12 y !12 tanto la solicitud de fusión 12 como 34 y #34 ambos nombre incidencia 34.
  • PIPELINE_ID y JOB_ID son los números que muestra pipelines ls y jobs ls.

ComandoObjetivo
champrep code projects lsMuestre los proyectos de los que es miembro. --search TEXT, --all (también los proyectos públicos e internos que pueda ver), --limit N.
champrep code projects show PROJECTMostrar un proyecto, su rama predeterminada y sus direcciones de clonación.
champrep code projects create NAMECree un proyecto en su espacio de nombres personal o en un grupo con --namespace. Además --path, --visibility private|internal|public, --description, --default-branch.
champrep code repo clone-url PROJECTMuestre la dirección de clonación HTTPS (--ssh (para la dirección SSH).
champrep code clone PROJECT...Clone los proyectos en --dest (por defecto .), cada uno bajo su propio espacio de nombres: DEST/<group>/<subgroup>/<project>.
champrep code clone --group GROUPClone todos los proyectos de un grupo; --include-subgroups Añade todos los subgrupos.
champrep code clone --membership / --owned / --allClone todos los proyectos de los que sea miembro, en los que su rol sea «Propietario» o que pueda ver.
champrep code branches ls PROJECTMuestre las ramas con su última confirmación. --search, --limit.
champrep code ssh-keys lsMuestre las claves SSH de su cuenta de Code.

code clone Opciones:

  • --ssh, o --https (por defecto), selecciona el protocolo.
  • --dry-run enumera lo que sucedería.
  • --parallel N Ejecuta N operaciones de Git a la vez (por defecto 4, como máximo 16).
  • --archived Incluye proyectos archivados.
  • --update Recupera y avanza rápidamente los proyectos ya clonados en lugar de omitirlos. Un clon cuyo origin Si se trata de otro repositorio, se indica como mismatch. Un HEAD desvinculado o una rama sin un upstream se notifica como no-upstream.
  • --search TEXT Conserva únicamente los proyectos que coinciden.
  • --max-projects N Gestiona como máximo N proyectos (por defecto, 1000), contados tras el --owned filtro.

Muestra un resumen y finaliza. 1 cuando falla cualquier proyecto o la ejecución se interrumpe (Ctrl-C detiene los nuevos clones y los que están en ejecución). Con --json it muestra una entrada por proyecto con su status.

Un clon masivo nunca solicita confirmación. Git se ejecuta con GIT_TERMINAL_PROMPT=0, y SSH se ejecuta con BatchMode=yes a menos que se configure GIT_SSH_COMMAND o core.sshCommand usted mismo. Solo https:// Se clonan las direcciones SSH en el host de CHAMPREP Code, y Git se ejecuta con todos los demás protocolos de transporte desactivados.

Git se autentica por sí mismo. Utilice una clave SSH o un token de acceso personal almacenado en el almacén de credenciales de Git; ambos se configuran una sola vez en la aplicación web Code; consulte Configurar las credenciales de Git. El CLI nunca incluye un token en una URL remota ni en .git/config.

mr también acepta merge-requests.

ComandoObjetivo
champrep code mr ls PROJECTMuestre las solicitudes de fusión. --state opened (por defecto), merged, closed, locked o all; --mine; --search; --limit.
champrep code mr show PROJECT IIDMuestre una solicitud de fusión, su estado de fusión y su canal principal.
champrep code mr create PROJECTAbra una solicitud de fusión. Requiere --source, --target y --title; además --description, --draft, --remove-source-branch, --squash.
champrep code mr merge PROJECT IIDFusionar ahora, o con --auto cuando el proceso se completa con éxito. Además, --squash, --remove-source-branch, --message, --sha.
champrep code mr approve PROJECT IIDAprobar. --sha asigna la aprobación a la confirmación que ha revisado.

ComandoObjetivo
champrep code issues ls PROJECTMostrar incidencias. --state opened (por defecto), closed o all; --labels a,b; --search; --mine (asignados a usted); --limit.
champrep code issues show PROJECT IIDMostrar un problema.
champrep code issues create PROJECTCrear una incidencia. Requiere --title; además --description, --labels, --confidential, --due YYYY-MM-DD.
champrep code issues close PROJECT IIDCerrar una incidencia.
champrep code issues reopen PROJECT IIDReabrir una incidencia cerrada.

pipelines también acepta pl.

ComandoObjetivo
champrep code pipelines ls PROJECTMostrar los flujos de trabajo, empezando por los más recientes. --ref, --status, --limit.
champrep code pipelines show PROJECT PIPELINE_IDMostrar un canal y todos los trabajos que contiene.
champrep code pipelines run PROJECT --ref REFEjecute un pipeline en una rama o una etiqueta. --var KEY=VALUE Añade una variable (repetible).
champrep code pipelines retry PROJECT PIPELINE_IDReintente los trabajos fallidos y cancelados.
champrep code pipelines cancel PROJECT PIPELINE_IDCancelar un pipeline en ejecución.
champrep code pipelines wait PROJECT [PIPELINE_ID]Esperar a que finalice una pipeline: la especificada, la más reciente de una confirmación con --sha SHA (o --sha HEAD en el repositorio; espera a que aparezca el pipeline), o el más reciente en --ref BRANCH en ese momento (por defecto: la rama predeterminada). Tras un «push», utilice --sha: --ref aún puede encontrar el flujo de trabajo de la confirmación anterior. Realiza comprobaciones con un intervalo creciente (de 5 s a 60 s); el progreso y la línea de estado final se envían a stderr, y --json muestra el pipeline completado. Un trabajo programado (retrasado) lo mantiene en espera. Sale 0 En caso de éxito, 1 cuando ha fallado, se ha cancelado o se ha omitido, o se ha detenido en un trabajo manual (--manual-ok lo acepta), y 8 cuando --timeout (por defecto 60m) se agota.
champrep code jobs ls PROJECTMostrar los trabajos, empezando por los más recientes, o los trabajos de una canalización con --pipeline ID. --status failed,running; --limit.
champrep code jobs log PROJECT JOB_IDMuestre el registro de un trabajo. --tail N muestra las últimas N líneas, leídas desde el final del registro, por lo que funciona con registros de cualquier tamaño. --follow (-f) sigue mostrando mensajes hasta que finaliza el trabajo; la línea de cierre «Job N finished» se envía a stderr, por lo que stdout solo contiene el registro, y el código de salida es el resultado del trabajo: 0 Cuando se haya ejecutado con éxito, 1 cuando ha fallado o se ha cancelado. Un registro de más de 8 MiB requiere --tail o --follow, que a continuación comienza a partir de sus últimas 100 líneas.
champrep code jobs play PROJECT JOB_IDInicie un trabajo manual. --var KEY=VALUE pasa una variable de trabajo.
champrep code jobs retry PROJECT JOB_IDReintente un trabajo finalizado.

runners también acepta runner.

ComandoObjetivo
champrep code runners lsEnumere los ejecutores de proyectos y grupos que gestiona. --project PROJECT (ejecutores que puede utilizar el proyecto; responsable del mantenimiento), --group GROUP (Propietario), --all (administradores de instancia). Filtros: --status online|offline|stale|never_contacted, --paused / --active, --tag a,b, --type instance|group|project, --search, --limit.
champrep code runners show RUNNER_IDMostrar estado, en línea, en pausa, etiquetas, último contacto, máquinas y proyectos o grupos asignados.
champrep code runners update RUNNER_ID--tags a,b sustituye la lista de etiquetas; --add-tag / --remove-tag (repetible) modifíquelo leyendo las etiquetas y volviendo a escribir la lista completa, de modo que cualquier cambio que alguien realice entretanto quede sobrescrito; --pause / --resume; --description.
champrep code runners createCree un ejecutor de proyecto (--project, responsable) o un ejecutor de grupo (--group, Propietario). Además --description, --tags, --no-untagged, --protected, --locked, --paused. Muestra el token de autenticación del ejecutor (ccrt_…) una vez en stdout y nunca lo registra en el log. Siempre requiere --yes. Alias register.

Conecte una máquina a un nuevo ejecutor con champrep-code-runner register. El restablecimiento de un token de ejecutor y la creación de ejecutores de instancia se realizan en la aplicación web.

ComandoObjetivo
champrep code releases ls PROJECTMostrar las versiones, empezando por las más recientes. --limit.

Las listas muestran 20 filas de forma predeterminada. Aumente --limit (hasta 500) para ver más; la CLI CLI se lo indica cuando hay más filas, y en --limit 500 le pedirá que restrinja los filtros en su lugar. jobs ls --pipeline ID --status S filtros por su parte tras leer los primeros 500 trabajos del canal, e indica cuándo puede haber más.

Encontrará más instrucciones paso a paso, con variantes de scripts, en Tareas comunes.

Clone un grupo completo, con sus subgrupos, y manténgalo actualizado:

Ventana de terminal
champrep code clone --group acme --include-subgroups --dest ~/src --ssh
champrep code clone --group acme --include-subgroups --dest ~/src --ssh --update

Clone un proyecto y abra una solicitud de fusión para su rama:

Ventana de terminal
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

Revise las solicitudes de fusión pendientes y fusione una cuando su canalización se supere:

Ventana de terminal
champrep code mr ls acme/web
champrep code mr show acme/web 12
champrep code mr merge acme/web 12 --auto --squash --yes

Ejecute un pipeline, espere a que finalice y siga el registro de un trabajo:

Ventana de terminal
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

Busque los trabajos fallidos y vuelva a intentar uno:

Ventana de terminal
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

Seguimiento de incidencias:

Ventana de terminal
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

Los comandos que modifican algo importante solicitan confirmación antes de actuar: mr create (abrir una solicitud de fusión puede iniciar un pipeline), mr merge, mr approve, issues close y reopen, runners update, y todas las acciones de pipeline y de trabajo (run, retry, cancel, play), que consumen minutos de CI. runners create Siempre requiere --yes, también en una terminal, ya que muestra una credencial. clone solo realiza cambios en su disco y no le pregunta. En una terminal, responda y. En un script, pase --yes (-y). Sin terminal y sin --yes El comando se rechaza y no cambia nada.

La creación de un proyecto o una incidencia no requiere confirmación. Crea, fusiona, ejecuta procesos en pipeline, realiza reintentos y cancela; además, las ejecuciones de tareas y los reintentos llevan una clave de idempotencia, por lo que CLIel reintento automático tras un error de red nunca realiza la tarea dos veces.

El CLI rechaza un argumento de proyecto, solicitud de fusión, incidencia, canalización o trabajo con un . o .. segmento de ruta antes de enviar nada.

Añadir --json Para mostrar el código devuelto: las listas muestran una matriz JSON de elementos, pipelines show imprime { "pipeline": …, "jobs": [ … ] }.

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

MensajeQué hacer
needs your web session … (SESSION_REQUIRED)La fusión o aprobación en un rama protegida Es una decisión que solo usted puede tomar, tras iniciar sesión en la aplicación web de CodeCHAMPREP. Abra la solicitud de fusión en su navegador y fúndala o apruébela desde allí. Las ramas no protegidas funcionan desde el CLI.
not allowed for your role … (MERGE_NOT_ALLOWED), (PROJECT_ARCHIVED)Su rol en el proyecto no le permite realizar la acción, o bien el proyecto está archivado (solo lectura). Consulte a un responsable de mantenimiento o al propietario.
not available to your account …Su plan o la política de su organización no incluye CHAMPREP Code ni esta función. Consulte Planes O consulte a su administrador.
quota exceeded …, payment required …Se ha agotado la capacidad de su plan o los minutos de CI. Aumente la capacidad en CHAMPREP«Facturación» y, a continuación, vuelva a ejecutar el comando.
not found …El proyecto, la solicitud de fusión, la incidencia o el proceso no existen, o bien no puede verlos.
http 409 … (SHA_MISMATCH)La solicitud de fusión se ha movido desde que la consultó. Compruebe mr show e inténtelo de nuevo.

Los códigos de salida siguen el Referencia de comandos: cada rechazo anterior finaliza 1, incluyendo --json ejecuciones; 3 significa que debe iniciar sesión de nuevo, 5 un límite de velocidad de la pasarela, 6 un fallo de red y 7 un fallo del servicio que los reintentos no lograron superar. pipelines wait salidas 1 cuando la cadena de procesos no haya tenido éxito y 8 cuando su --timeout se agotó; jobs log --follow salidas 1 cuando el trabajo haya fallado o se haya cancelado. Tanto la espera como el reintento se realizan de forma autónoma ante errores del servicio, límites de frecuencia y fallos de red, y se abandonan tras ocho reintentos consecutivos.