CHAMPREP Code-Befehle
champrep code Arbeitet mit CodeCHAMPREP von Ihrem Terminal aus: Projekte und Zweige, Massenklonen, Merge-Anfragen, Issues, Pipelines und Job-Protokolle, CI- Runner sowie Releases. Es handelt in Ihrem Namen mit Ihrer normalen CLIAnmeldung, sodass Code Ihre Rolle in jedem Projekt, Ihren Tarif und Ihre Kontingente genau wie die Web-App anwendet.
Bevor Sie beginnen
Abschnitt betitelt „Bevor Sie beginnen“- Installieren Sie die CLI und Anmelden mit
champrep auth login. - Ihr Tarif muss CHAMPREP„Code“ enthalten. Ist dies nicht der Fall, werden die Befehle mit
not available to your account(Exit-Code1).
champrep auth loginchamprep code projects ls
Benennung von Projekten, Merge-Anfragen und Issues
Abschnitt betitelt „Benennung von Projekten, Merge-Anfragen und Issues“PROJECTist der vollständige Pfad des Projekts, zum Beispielacme/weboder dessen ID. Der Pfad lässt sich am einfachsten eingeben.- Merge-Anfragen und Issues werden pro Projekt nummeriert. Geben Sie die Nummer an:
12und!12sowohl den Namen des Merge-Requests 12 als auch34und#34sowohl Name Issue 34. PIPELINE_IDundJOB_IDsind die Zahlen, die vonpipelines lsundjobs ls.
Befehle
Abschnitt betitelt „Befehle“
Projekte und Repositorys
Abschnitt betitelt „Projekte und Repositorys“| Befehl | Zweck |
|---|---|
champrep code projects ls | Listen Sie die Projekte auf, denen Sie angehören. --search TEXT, --all (sowie öffentliche und interne Projekte, die Sie einsehen können), --limit N. |
champrep code projects show PROJECT | Zeigen Sie ein Projekt, dessen Standard-Branch und dessen Klonadressen an. |
champrep code projects create NAME | Erstellen Sie ein Projekt in Ihrem persönlichen Namensraum oder in einer Gruppe mit --namespace. Außerdem --path, --visibility private|internal|public, --description, --default-branch. |
champrep code repo clone-url PROJECT | Geben Sie die HTTPS-Klonadresse aus (--ssh (für die SSH-Adresse). |
champrep code clone PROJECT... | Projekte klonen in --dest (Standard .), jeweils unter ihrem eigenen Namensraum: DEST/<group>/<subgroup>/<project>. |
champrep code clone --group GROUP | Klonen Sie jedes Projekt einer Gruppe; --include-subgroups Fügt jede Untergruppe hinzu. |
champrep code clone --membership / --owned / --all | Klonen Sie jedes Projekt, in dem Sie Mitglied sind, in dem Sie die Rolle „Eigentümer“ innehaben oder das Sie einsehen können. |
champrep code branches ls PROJECT | Listen Sie Zweige mit ihrem letzten Commit auf. --search, --limit. |
champrep code ssh-keys ls | Listen Sie die SSH-Schlüssel Ihres Code-Kontos auf. |
code clone Optionen:
--ssh, oder--https(Standard), wählt das Protokoll aus.--dry-runlistet auf, was geschehen würde.--parallel NFührt N Git-Operationen gleichzeitig aus (Standard: 4, maximal 16).--archivedBezieht archivierte Projekte mit ein.--updateRuft bereits geklonte Projekte ab und führt ein Fast-Forward durch, anstatt sie zu überspringen. Ein Klon, dessenoriginBefindet sich in einem anderen Repository, wird dies wie folgt gemeldet:mismatch. Ein „detached HEAD“ oder ein Zweig ohne Upstream wird alsno-upstream.--search TEXTBehält nur die Projekte bei, die den Kriterien entsprechen.--max-projects NVerarbeitet höchstens N Projekte (Standard: 1000), gezählt nach dem--ownedFilter.
Es gibt eine Zusammenfassung aus und beendet den Vorgang. 1 wenn ein Projekt fehlgeschlagen ist oder der Lauf unterbrochen wurde (Strg-C stoppt neue Klone und die laufenden). Mit --json Es gibt pro Projekt einen Eintrag mit dessen status.
Ein Bulk-Klon fordert niemals zur Eingabe auf. Git läuft mit GIT_TERMINAL_PROMPT=0, und SSH wird ausgeführt mit BatchMode=yes es sei denn, Sie legen fest GIT_SSH_COMMAND oder
core.sshCommand selbst. Nur https:// und SSH-Adressen auf dem CHAMPREP Code-Host werden geklont, und Git wird ausgeführt, wobei alle anderen Transportprotokolle deaktiviert sind.
Git führt die Authentifizierung selbstständig durch. Verwenden Sie einen SSH-Schlüssel oder ein persönliches Zugriffstoken, das im Anmeldedaten-Speicher von Git verwahrt wird; beides wird einmalig in der Code-Web-App eingerichtet; siehe
Git-Anmeldedaten einrichten. Das fügt CLI niemals ein Token in eine Remote-URL oder in .git/config.
Merge-Anfragen
Abschnitt betitelt „Merge-Anfragen“mr akzeptiert auch merge-requests.
| Befehl | Zweck |
|---|---|
champrep code mr ls PROJECT | Merge-Anfragen auflisten. --state opened (Standard), merged, closed, locked oder all; --mine; --search; --limit. |
champrep code mr show PROJECT IID | Zeigen Sie einen Merge-Request, dessen Merge-Status und dessen Head-Pipeline an. |
champrep code mr create PROJECT | Öffnen Sie einen Merge-Request. Erfordert --source, --target und --title; außerdem --description, --draft, --remove-source-branch, --squash. |
champrep code mr merge PROJECT IID | Jetzt zusammenführen oder mit --auto wenn die Pipeline erfolgreich ist. Außerdem --squash, --remove-source-branch, --message, --sha. |
champrep code mr approve PROJECT IID | Genehmigen. --sha heftet die Genehmigung an den von Ihnen geprüften Commit an. |
Probleme
Abschnitt betitelt „Probleme“| Befehl | Zweck |
|---|---|
champrep code issues ls PROJECT | Probleme auflisten. --state opened (Standard), closed oder all; --labels a,b; --search; --mine (Ihnen zugewiesen); --limit. |
champrep code issues show PROJECT IID | Ein Problem anzeigen. |
champrep code issues create PROJECT | Erstellen Sie ein Ticket. Erfordert --title; außerdem --description, --labels, --confidential, --due YYYY-MM-DD. |
champrep code issues close PROJECT IID | Ein Ticket schließen. |
champrep code issues reopen PROJECT IID | Ein geschlossenes Ticket erneut öffnen. |
Pipelines und Aufträge
Abschnitt betitelt „Pipelines und Aufträge“pipelines akzeptiert auch pl.
| Befehl | Zweck |
|---|---|
champrep code pipelines ls PROJECT | Pipelines auflisten, beginnend mit den neuesten. --ref, --status, --limit. |
champrep code pipelines show PROJECT PIPELINE_ID | Zeigen Sie eine Pipeline und jeden darin enthaltenen Auftrag an. |
champrep code pipelines run PROJECT --ref REF | Führen Sie eine Pipeline auf einem Branch oder Tag aus. --var KEY=VALUE Fügt eine Variable hinzu (wiederholbar). |
champrep code pipelines retry PROJECT PIPELINE_ID | Wiederholen Sie die fehlgeschlagenen und abgebrochenen Aufträge. |
champrep code pipelines cancel PROJECT PIPELINE_ID | Eine laufende Pipeline abbrechen. |
champrep code pipelines wait PROJECT [PIPELINE_ID] | Warten, bis eine Pipeline abgeschlossen ist: die angegebene oder die neueste eines Commits mit --sha SHA (oder --sha HEAD im Repository; er wartet, bis die Pipeline erscheint), oder die neueste auf --ref BRANCH zu diesem Zeitpunkt (Standard: der Standardzweig). Verwenden Sie nach einem Push --sha: --ref kann die Pipeline des vorherigen Commits weiterhin finden. Führt Überprüfungen mit einem ansteigenden Intervall (5 s bis 60 s) durch; der Fortschritt und die abschließende Statuszeile werden an stderr ausgegeben, und --json gibt die abgeschlossene Pipeline aus. Ein geplanter (verzögerter) Auftrag hält den Prozess in Wartestellung. Beendet den Prozess 0 Bei Erfolg, 1 wenn er fehlgeschlagen ist, abgebrochen oder übersprungen wurde oder bei einem manuellen Job gestoppt wurde (--manual-ok akzeptiert dies), und 8 wenn --timeout (Standard 60m) läuft ab. |
champrep code jobs ls PROJECT | Aufträge auflisten, beginnend mit den neuesten, oder die Aufträge einer bestimmten Pipeline mit --pipeline ID. --status failed,running; --limit. |
champrep code jobs log PROJECT JOB_ID | Geben Sie das Protokoll eines Jobs aus. --tail N gibt die letzten N Zeilen aus, die vom Ende des Protokolls gelesen werden, sodass es bei Protokollen beliebiger Größe funktioniert. --follow (-f) gibt so lange Ausgaben aus, bis der Job beendet ist; die abschließende Zeile „Job N finished“ wird an stderr ausgegeben, sodass stdout nur das Protokoll enthält und der Exit-Code das Ergebnis des Jobs darstellt: 0 Wenn der Vorgang erfolgreich war, 1 wenn der Vorgang fehlgeschlagen ist oder abgebrochen wurde. Ein Protokoll, das größer als 8 MiB ist, benötigt --tail oder --follow, das dann ab den letzten 100 Zeilen fortfährt. |
champrep code jobs play PROJECT JOB_ID | Starten Sie einen manuellen Auftrag. --var KEY=VALUE übergibt eine Auftragsvariable. |
champrep code jobs retry PROJECT JOB_ID | Wiederholen Sie einen abgeschlossenen Auftrag. |
runners akzeptiert auch runner.
| Befehl | Zweck |
|---|---|
champrep code runners ls | Listen Sie die Projekt- und Gruppen-Runner auf, die Sie verwalten. --project PROJECT (Runner, die das Projekt nutzen kann; Maintainer), --group GROUP (Eigentümer), --all (Instanzadministratoren). Filter: --status online|offline|stale|never_contacted, --paused / --active, --tag a,b, --type instance|group|project, --search, --limit. |
champrep code runners show RUNNER_ID | Zeigen Sie Status, Online-Status, Pausenzustand, Tags, letzten Kontakt, Maschinen sowie zugewiesene Projekte oder Gruppen an. |
champrep code runners update RUNNER_ID | --tags a,b ersetzt die Tag-Liste; --add-tag / --remove-tag (wiederholbar) Ändern Sie dies, indem Sie die Tags auslesen und die gesamte Liste zurückschreiben, sodass eine Änderung, die jemand dazwischen vornimmt, überschrieben wird; --pause / --resume; --description. |
champrep code runners create | Erstellen Sie einen Projekt-Runner (--project, Betreuer) oder ein Gruppen-Runner (--group, Eigentümer). Außerdem --description, --tags, --no-untagged, --protected, --locked, --paused. Gibt das Authentifizierungstoken des Runners aus (ccrt_…) einmal auf stdout und protokolliert dies niemals. Benötigt immer --yes. Alias register. |
Verbinden Sie einen Rechner mit einem neuen Runner über
champrep-code-runner register. Das Zurücksetzen eines Runner-Tokens und das Erstellen von Instanz-Runner erfolgen weiterhin in der Web-App.
Veröffentlichungen
Abschnitt betitelt „Veröffentlichungen“| Befehl | Zweck |
|---|---|
champrep code releases ls PROJECT | Listen Sie Releases auf, beginnend mit den neuesten. --limit. |
Standardmäßig werden 20 Zeilen angezeigt. Erhöhen --limit (bis zu 500), um mehr anzuzeigen; die CLI CLI weist darauf hin, wenn weitere Zeilen vorhanden sind, und fordert Sie in diesem Fall auf, --limit 500 Sie werden aufgefordert, die Filter stattdessen einzugrenzen. jobs ls --pipeline ID --status S Filter auf Ihrer Seite nach dem Einlesen der ersten 500 Aufträge der Pipeline und weist darauf hin, wenn möglicherweise weitere vorhanden sind.
Beispiele
Abschnitt betitelt „Beispiele“Weitere Anleitungen für einzelne Aufgaben, einschließlich Skriptvarianten, finden Sie unter Häufige Aufgaben.
Klonen Sie eine gesamte Gruppe mit ihren Untergruppen und halten Sie sie auf dem neuesten Stand:
champrep code clone --group acme --include-subgroups --dest ~/src --sshchamprep code clone --group acme --include-subgroups --dest ~/src --ssh --updateKlonen Sie ein Projekt und eröffnen Sie einen Merge-Request für Ihren Branch:
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Überprüfen Sie offene Merge-Anfragen und führen Sie eine Zusammenführung durch, sobald deren Pipeline erfolgreich durchlaufen wurde:
champrep code mr ls acme/webchamprep code mr show acme/web 12champrep code mr merge acme/web 12 --auto --squash --yesFühren Sie eine Pipeline aus, warten Sie, bis sie abgeschlossen ist, und verfolgen Sie das Protokoll eines Jobs:
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 --followSuchen Sie fehlgeschlagene Aufträge und wiederholen Sie einen davon:
champrep code jobs ls acme/web --status failedchamprep code jobs log acme/web 4180 --tail 50champrep code jobs retry acme/web 4180 --yesProbleme nachverfolgen:
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
Bestätigung und Skripterstellung
Abschnitt betitelt „Bestätigung und Skripterstellung“Befehle, die wesentliche Änderungen bewirken, fragen vor der Ausführung nach: mr create
(Das Eröffnen eines Merge-Requests kann eine Pipeline starten), mr merge, mr approve,
issues close und reopen, runners updatesowie jede Pipeline- und Job- Aktion (run, retry, cancel, play), die CI-Minuten verbrauchen.
runners create benötigt immer --yes, auch auf einem Terminal, da dabei eine Anmeldeinformation ausgegeben wird. clone „“ ändert nur Ihre Festplatte und fragt nicht nach. Geben Sie am Terminal y. In einem Skript übergeben Sie --yes (-y). Ohne Terminal und ohne --yes Der Befehl wird abgelehnt und es wird nichts geändert.
Beim Erstellen eines Projekts oder eines Issues erfolgt keine Abfrage. Erstellen, Zusammenführen, Pipeline-Läufe, Wiederholungsversuche und Abbrüche sowie Jobausführungen und Wiederholungsversuche sind mit einem Idempotenzschlüssel versehen, sodass CLIder automatische Wiederholungsversuch nach einem Netzwerkfehler die Arbeit niemals doppelt ausführt.
Der CLI lehnt ein Projekt, eine Merge-Anfrage, ein Ticket, eine Pipeline oder ein Job-Argument mit einem . oder .. Pfadsegment, bevor etwas gesendet wird.
Hinzufügen --json Um den zurückgegebenen Code auszugeben: Die Listen geben ein JSON-Array von Elementen aus,
pipelines show gibt aus { "pipeline": …, "jobs": [ … ] }.
champrep code mr ls acme/web --json | jq -r '.[] | "\(.iid) \(.title)"'
Mögliche Fehlermeldungen
Abschnitt betitelt „Mögliche Fehlermeldungen“| Meldung | Was ist zu tun? |
|---|---|
needs your web session … (SESSION_REQUIRED) | Das Zusammenführen oder Genehmigen in einen Geschützter Zweig Diese Entscheidung können nur Sie treffen, nachdem Sie sich bei der CHAMPREPCode-Web-App angemeldet haben. Öffnen Sie den Merge-Request in Ihrem Browser und führen Sie dort die Zusammenführung durch oder genehmigen Sie ihn. Ungeschützte Zweige funktionieren über die CLI. |
not allowed for your role … (MERGE_NOT_ALLOWED), (PROJECT_ARCHIVED) | Ihre Rolle im Projekt erlaubt die Aktion nicht, oder das Projekt ist archiviert (schreibgeschützt). Wenden Sie sich an einen Betreuer oder Eigentümer. |
not available to your account … | Ihr Tarif oder die Richtlinien Ihrer Organisation umfassen weder CHAMPREP„Code“ noch diese Funktion. Siehe Pläne Oder wenden Sie sich an Ihren Administrator. |
quota exceeded …, payment required … | Die Kapazität Ihres Tarifs oder Ihre CI-Minuten sind aufgebraucht. Erhöhen Sie die Kapazität unter CHAMPREP„Abrechnung“ und führen Sie den Befehl anschließend erneut aus. |
not found … | Das Projekt, der Merge-Request, das Ticket oder die Pipeline existiert nicht oder ist für Sie nicht sichtbar. |
http 409 … (SHA_MISMATCH) | Der Merge-Request wurde verschoben, seit Sie ihn zuletzt angesehen haben. Bitte überprüfen Sie mr show und versuchen Sie es erneut. |
Die Exit-Codes folgen dem Befehlsreferenz: Jede der oben genannten Ablehnungen führt zum Beenden des Programms 1, einschließlich --json Läuft; 3 bedeutet, dass Sie sich erneut anmelden müssen, 5 eine Gateway-Ratenbegrenzung, 6 ein Netzwerkausfall und 7 Ein Dienstausfall, den die Wiederholungsversuche nicht beheben konnten. pipelines wait exits 1 wenn die Pipeline fehlgeschlagen ist und 8 wenn dessen --timeout ist abgelaufen; jobs log --follow exits 1 wenn der Auftrag fehlgeschlagen ist oder abgebrochen wurde. Sowohl „wait“ als auch „retry“ reagieren eigenständig auf Dienstfehler, Ratenbeschränkungen und Netzwerkausfälle und geben nach acht aufeinanderfolgenden Wiederholungsversuchen auf.