CHAMPREP Commandes de code
champrep code fonctionne avec CHAMPREP Code depuis votre terminal : projets et branches, clonage en masse, demandes de fusion, tickets, pipelines et journaux de tâches, runners CI et versions. Il agit en votre nom, avec votre CLIconnexion habituelle, de sorte que Code applique votre rôle dans chaque projet, votre forfait et vos quotas exactement comme le fait l’application web.
Avant de commencer
Section intitulée « Avant de commencer »- Installez le CLI et se connecter avec
champrep auth login. - Votre forfait doit inclure CHAMPREP Code. Si ce n’est pas le cas, les commandes s’arrêtent avec
not available to your account(code de sortie1).
champrep auth loginchamprep code projects ls
Nommer les projets, les demandes de fusion et les tickets
Section intitulée « Nommer les projets, les demandes de fusion et les tickets »PROJECTcorrespond au chemin d’accès complet du projet, par exempleacme/web, ou son identifiant. Le chemin d’accès est le plus simple à saisir.- Les demandes de fusion et les tickets sont numérotés par projet. Indiquez le numéro :
12et!12à la fois le nom de la demande de fusion 12, et34et#34les deux : nom problème 34. PIPELINE_IDetJOB_IDsont les nombres affichés parpipelines lsetjobs ls.
Commandes
Section intitulée « Commandes »
Projets et dépôts
Section intitulée « Projets et dépôts »| Commande | Objectif |
|---|---|
champrep code projects ls | Affichez la liste des projets dont vous êtes membre. --search TEXT, --all (ainsi que les projets publics et internes que vous pouvez consulter), --limit N. |
champrep code projects show PROJECT | Afficher un projet, sa branche par défaut et ses adresses de clonage. |
champrep code projects create NAME | Créez un projet dans votre espace de noms personnel ou au sein d’un groupe à l’aide de --namespace. Également --path, --visibility private|internal|public, --description, --default-branch. |
champrep code repo clone-url PROJECT | Afficher l’adresse de clonage HTTPS (--ssh pour l’adresse SSH). |
champrep code clone PROJECT... | Clonez les projets dans --dest (par défaut .), chacun sous son propre espace de noms : DEST/<group>/<subgroup>/<project>. |
champrep code clone --group GROUP | Clonez tous les projets d’un groupe ; --include-subgroups Ajoute chaque sous-groupe. |
champrep code clone --membership / --owned / --all | Clonez tous les projets dont vous êtes membre, pour lesquels vous avez le rôle de propriétaire, ou que vous pouvez consulter. |
champrep code branches ls PROJECT | Répertorier les branches avec leur dernier commit. --search, --limit. |
champrep code ssh-keys ls | Répertoriez les clés SSH associées à votre compte Code. |
code clone Options :
--ssh, ou--https(par défaut), sélectionne le protocole.--dry-runrépertorie ce qui se passerait.--parallel NExécute N opérations Git simultanément (par défaut 4, au maximum 16).--archivedinclut les projets archivés.--updateRécupère et effectue un « fast-forward » sur les projets déjà clonés au lieu de les ignorer. Un clone dont leoriginSi un autre dépôt est signalé commemismatch. Un HEAD détaché ou une branche sans en amont est signalé commeno-upstream.--search TEXTNe conserve que les projets qui correspondent.--max-projects NGère au maximum N projets (par défaut 1 000), comptés après le--ownedfiltre.
Il affiche un résumé puis se termine 1 lorsqu’un projet a échoué ou que l’exécution a été interrompue (Ctrl-C arrête les nouveaux clones et ceux en cours d’exécution). Avec --json it affiche une entrée par projet avec son status.
Un clonage en masse ne demande jamais de confirmation. git s’exécute avec GIT_TERMINAL_PROMPT=0, et SSH s’exécute avec BatchMode=yes à moins que vous ne définissiez GIT_SSH_COMMAND ou
core.sshCommand vous-même. Uniquement https:// Les adresses SSH sur l’hôte CHAMPREP Code sont clonées, et git s’exécute avec tous les autres protocoles de transport désactivés.
git s’authentifie de manière autonome. Utilisez une clé SSH ou un jeton d’accès personnel conservé dans le magasin d’identifiants de git, tous deux configurés une seule fois dans l’application web Code ; voir
Configurer les identifiants Git. La commande n’insère CLI jamais de jeton dans une URL distante ni dans .git/config.
Demandes de fusion
Section intitulée « Demandes de fusion »mr accepte également merge-requests.
| Commande | Objectif |
|---|---|
champrep code mr ls PROJECT | Répertorier les demandes de fusion. --state opened (par défaut), merged, closed, locked ou all; --mine; --search; --limit. |
champrep code mr show PROJECT IID | Afficher une demande de fusion, son statut de fusion et son pipeline principal. |
champrep code mr create PROJECT | Ouvrez une demande de fusion. Nécessite --source, --target et --title; également --description, --draft, --remove-source-branch, --squash. |
champrep code mr merge PROJECT IID | Fusionner maintenant, ou avec --auto lorsque le pipeline aboutit. Également --squash, --remove-source-branch, --message, --sha. |
champrep code mr approve PROJECT IID | Approuver. --sha associe l’approbation à la validation que vous avez examinée. |
Problèmes
Section intitulée « Problèmes »| Commande | Objectif |
|---|---|
champrep code issues ls PROJECT | Répertorier les tickets. --state opened (par défaut), closed ou all; --labels a,b; --search; --mine (qui vous sont attribués) ; --limit. |
champrep code issues show PROJECT IID | Afficher un ticket. |
champrep code issues create PROJECT | Créer un ticket. Nécessite --title; également --description, --labels, --confidential, --due YYYY-MM-DD. |
champrep code issues close PROJECT IID | Fermer un ticket. |
champrep code issues reopen PROJECT IID | Rouvrir un ticket fermé. |
Pipelines et tâches
Section intitulée « Pipelines et tâches »pipelines accepte également pl.
| Commande | Objectif |
|---|---|
champrep code pipelines ls PROJECT | Répertorier les pipelines, les plus récents en premier. --ref, --status, --limit. |
champrep code pipelines show PROJECT PIPELINE_ID | Afficher un pipeline et toutes les tâches qu’il contient. |
champrep code pipelines run PROJECT --ref REF | Exécutez un pipeline sur une branche ou une balise. --var KEY=VALUE ajoute une variable (répétable). |
champrep code pipelines retry PROJECT PIPELINE_ID | Réessayez les tâches ayant échoué ou ayant été annulées. |
champrep code pipelines cancel PROJECT PIPELINE_ID | Annuler un pipeline en cours d’exécution. |
champrep code pipelines wait PROJECT [PIPELINE_ID] | Attendez la fin d’un pipeline : celui spécifié, ou le plus récent d’un commit avec --sha SHA (ou --sha HEAD dans le référentiel ; il attend que le pipeline apparaisse), ou le plus récent sur --ref BRANCH à ce moment-là (par défaut : la branche par défaut). Après un « push », utilisez --sha: --ref peut toujours retrouver le pipeline du commit précédent. Effectue des vérifications à un intervalle croissant (de 5 s à 60 s) ; la progression et la ligne d’état finale sont envoyées vers stderr, et --json affiche le pipeline terminé. Une tâche planifiée (différée) le maintient en attente. Quitte 0 en cas de réussite, 1 lorsqu’il a échoué, a été annulé ou ignoré, ou a été interrompu lors d’une tâche manuelle (--manual-ok l’accepte), et 8 lorsque --timeout (par défaut) 60m) arrive à expiration. |
champrep code jobs ls PROJECT | Répertorier les tâches, les plus récentes en premier, ou les tâches d’un pipeline avec --pipeline ID. --status failed,running; --limit. |
champrep code jobs log PROJECT JOB_ID | Affichez le journal d’un travail. --tail N affiche les N dernières lignes, lues à partir de la fin du journal, ce qui lui permet de fonctionner sur un journal de n’importe quelle taille. --follow (-f) continue à afficher des messages jusqu’à la fin de la tâche ; la ligne de fin « Job N finished » est envoyée vers stderr, de sorte que stdout ne contient que le journal, et le code de sortie correspond au résultat de la tâche : 0 lorsqu’elle a abouti, 1 lorsqu’elle a échoué ou a été annulée. Un journal dépassant 8 Mio nécessite --tail ou --follow, qui reprend alors à partir de ses 100 dernières lignes. |
champrep code jobs play PROJECT JOB_ID | Lancer une tâche manuelle. --var KEY=VALUE transmet une variable de tâche. |
champrep code jobs retry PROJECT JOB_ID | Réessayer une tâche terminée. |
runners accepte également runner.
| Commande | Objectif |
|---|---|
champrep code runners ls | Répertoriez les runners de projet et de groupe que vous gérez. --project PROJECT (runners que le projet peut utiliser ; responsable de maintenance), --group GROUP (Propriétaire), --all (administrateurs d’instance). Filtres : --status online|offline|stale|never_contacted, --paused / --active, --tag a,b, --type instance|group|project, --search, --limit. |
champrep code runners show RUNNER_ID | Affichez le statut, la connexion, la mise en pause, les balises, le dernier contact, les machines et les projets ou groupes attribués. |
champrep code runners update RUNNER_ID | --tags a,b remplace la liste des balises ; --add-tag / --remove-tag (répétable) modifiez-la en lisant les balises et en réécrivant la liste complète, de sorte qu’une modification effectuée entre-temps soit écrasée ; --pause / --resume; --description. |
champrep code runners create | Créez un exécuteur de projet (--project, responsable) ou un exécuteur de groupe (--group, Propriétaire). Également --description, --tags, --no-untagged, --protected, --locked, --paused. Affiche le jeton d’authentification du runner (ccrt_…) une seule fois sur stdout et ne l’enregistre jamais dans les journaux. Nécessite toujours --yes. Alias register. |
Connectez une machine à un nouveau runner avec
champrep-code-runner register. La réinitialisation d’un jeton de runner et la création d’instances de runners s’effectuent dans l’application web.
Versions
Section intitulée « Versions »| Commande | Objectif |
|---|---|
champrep code releases ls PROJECT | Répertorier les versions, en commençant par les plus récentes. --limit. |
Les listes affichent 20 lignes par défaut. Augmentez --limit (jusqu’à 500) pour en voir davantage ; l’interface CLI vous en informe lorsqu’il existe davantage de lignes, et --limit 500 il vous demande alors d’affiner les filtres à la place. jobs ls --pipeline ID --status S filtres de votre côté après avoir lu les 500 premières tâches du pipeline, et vous indique quand d’autres pourraient exister.
Exemples
Section intitulée « Exemples »Vous trouverez d’autres recettes tâche par tâche, avec des variantes de scripts, dans Tâches courantes.
Clonez un groupe entier, avec ses sous-groupes, et maintenez-le à jour :
champrep code clone --group acme --include-subgroups --dest ~/src --sshchamprep code clone --group acme --include-subgroups --dest ~/src --ssh --updateClonez un projet et ouvrez une demande de fusion pour votre branche :
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 --yesPassez en revue les demandes de fusion en attente et fusionnez-en une lorsque son pipeline est validé :
champrep code mr ls acme/webchamprep code mr show acme/web 12champrep code mr merge acme/web 12 --auto --squash --yesLancez un pipeline, attendez qu’il s’exécute, puis suivez le journal d’un travail :
champrep code pipelines run acme/web --ref main --var DEPLOY=staging --yeschamprep code pipelines wait acme/web --ref main && echo "main is green"champrep code pipelines ls acme/web --ref main --limit 5champrep code pipelines show acme/web 9921champrep code jobs log acme/web 4182 --followRecherchez les tâches ayant échoué et réessayez-en une :
champrep code jobs ls acme/web --status failedchamprep code jobs log acme/web 4180 --tail 50champrep code jobs retry acme/web 4180 --yesSuivi des problèmes :
champrep code issues ls acme/web --labels bug --search loginchamprep code issues create acme/web --title "Login fails on Safari" --labels bug,webchamprep code issues close acme/web 34 --yes
Confirmation et scripts
Section intitulée « Confirmation et scripts »Les commandes qui modifient des éléments importants vous demandent votre accord avant d’agir : mr create
(l’ouverture d’une demande de fusion peut lancer un pipeline), mr merge, mr approve,
issues close et reopen, runners update, ainsi que chaque action de pipeline et de tâche (run, retry, cancel, play), qui utilisent des minutes de CI.
runners create nécessite toujours --yes, même sur un terminal, car elle affiche une information d’identification. clone ne modifie que votre disque et ne vous demande pas de confirmation. Sur un terminal, répondez y. Dans un script, transmettez --yes (-y). Sans terminal et sans --yes La commande est refusée et ne modifie rien.
La création d’un projet ou d’un ticket ne nécessite aucune authentification. Les opérations de création, de fusion, d’exécution de pipeline, de nouvelle tentative et d’annulation, ainsi que l’exécution et les nouvelles tentatives des tâches, sont associées à une clé d’idempotence ; ainsi, la CLInouvelle tentative automatique après une erreur réseau n’effectue jamais deux fois la même tâche.
Le CLI refuse un argument de projet, de demande de fusion, de ticket, de pipeline ou de tâche avec un . ou .. segment de chemin avant d’envoyer quoi que ce soit.
Ajouter --json Pour afficher le code renvoyé : les listes affichent un tableau JSON d’éléments,
pipelines show affiche { "pipeline": …, "jobs": [ … ] }.
champrep code mr ls acme/web --json | jq -r '.[] | "\(.iid) \(.title)"'
Erreurs que vous pourriez rencontrer
Section intitulée « Erreurs que vous pourriez rencontrer »| Message | Que faire ? |
|---|---|
needs your web session … (SESSION_REQUIRED) | Fusion ou validation dans un branche protégée C’est une décision que vous seul pouvez prendre, une fois connecté à l’application web CodeCHAMPREP. Ouvrez la demande de fusion dans votre navigateur et fusionnez-la ou approuvez-la à partir de là. Les branches non protégées fonctionnent à partir de CLI. |
not allowed for your role … (MERGE_NOT_ALLOWED), (PROJECT_ARCHIVED) | Votre rôle dans le projet ne vous autorise pas à effectuer cette action, ou le projet est archivé (en lecture seule). Adressez-vous à un responsable de maintenance ou à un propriétaire. |
not available to your account … | Votre forfait ou la politique de votre organisation n’inclut pas CHAMPREPCode ou cette fonctionnalité. Consultez plans Ou adressez-vous à votre administrateur. |
quota exceeded …, payment required … | La capacité de votre forfait ou vos minutes CI sont épuisées. Augmentez la capacité dans la section « FacturationCHAMPREP », puis relancez la commande. |
not found … | Le projet, la demande de fusion, le ticket ou le pipeline n’existe pas, ou vous ne pouvez pas le voir. |
http 409 … (SHA_MISMATCH) | La demande de fusion a été déplacée depuis votre dernière consultation. Vérifiez mr show et réessayez. |
Les codes de sortie respectent la Référence des commandes: chaque refus ci-dessus entraîne la sortie du programme 1, y compris --json exécutions ; 3 signifie que vous devez vous reconnecter , 5 une limite de débit de la passerelle, 6 une panne réseau et 7 une défaillance de service que les tentatives de réessai n’ont pas permis de contourner. pipelines wait sorties 1 lorsque le pipeline a échoué et 8 lorsque son --timeout a expiré ; jobs log --follow sorties 1 lorsque la tâche a échoué ou a été annulée. Les commandes « wait » et « retry » gèrent de manière autonome les erreurs de service, les limites de débit et les pannes réseau, et abandonnent après huit tentatives consécutives.