Häufige Aufgaben für Code, Runner Farm und QA
Diese Seite enthält eine Sammlung kurzer Anleitungen. Jede davon löst eine einzelne Aufgabe mit Befehlen, die Sie kopieren können. Wo ein Skript hilfreich ist, gibt es eine --json | jq Variante. Informationen zu jedem Flag eines Befehls finden Sie auf den Referenzseiten:
CHAMPREP Code, Runner Farm und
CHAMPREP QA.
In den Beispielen, acme ist eine Gruppe, acme/web ist ein Projekt, und
code.champrep.com ist CodeCHAMPREP.
Melden Sie sich an und wählen Sie ein Konto aus
Abschnitt betitelt „Melden Sie sich an und wählen Sie ein Konto aus“champrep auth login # opens the browser to approve the sign-inchamprep auth whoami # who the CLI acts aschamprep auth list # stored sign-ins, across environmentschamprep auth switch PROFILE # make another stored sign-in the active onechamprep --env test code projects ls # one command against the test environmentCHAMPREP Code verfügt über keine separate Umschaltung zwischen Arbeitsbereichen. Ein Projekt gehört zu einer Gruppe oder zu Ihrem persönlichen Namensraum, und Ihre Rolle darin bestimmt, was Sie tun können.
Runner Farm und QA agieren in einem Arbeitsbereich: Ihrem persönlichen Konto, einer Organisation oder einem Team. Listen Sie die Projekte auf, die Sie verwenden können, und übergeben Sie dann die KEY Spalte von rf accounts ls (personal, organization:<id> oder team:<id>) mit
--workspace:
champrep rf accounts ls # KEY, workspace, your role, whether a farm account existschamprep org ls # the same organizations and teams (ACCOUNT column)champrep rf pools ls --workspace organization:65f0c0ffee0000000000abcdchamprep qa repos ls --workspace team:65f0c0ffee0000000000beefchamprep org use NAME legt die Standardeinstellung für Organisationsbefehle wie
business members. Runner Farm und QA ignorieren dies. Übergeben Sie --workspace in diese, oder lassen Sie den Dienst den Arbeitsbereich so auswählen, wie es die Web-App tut.
CHAMPREP Code
Abschnitt betitelt „CHAMPREP Code“
Ein Projekt und dessen Klonadresse finden
Abschnitt betitelt „Ein Projekt und dessen Klonadresse finden“champrep code projects ls --search webchamprep code projects show acme/web # default branch, HTTPS and SSH addresseschamprep code repo clone-url acme/web # HTTPS addresschamprep code repo clone-url acme/web --ssh # SSH addressgit clone "$(champrep code repo clone-url acme/web --ssh)"Skriptvariante:
champrep code projects ls --limit 500 --json | jq -r '.[].path_with_namespace'champrep code projects show acme/web --json | jq -r .ssh_url_to_repo
Git-Anmeldedaten einrichten
Abschnitt betitelt „Git-Anmeldedaten einrichten“Git kommuniziert direkt mit CHAMPREPCode, nicht über denCLI, daher benötigt es eigene Anmeldedaten. CHAMPREPCode akzeptiert Ihre CLIAnmeldung nicht als Git-Passwort. Das Erstellen eines persönlichen Zugriffstokens oder das Hinzufügen eines SSH-Schlüssels stellt eine Änderung der Anmeldedaten dar, daher ist Ihre angemeldete Websitzung erforderlich. Führen Sie diesen Vorgang einmalig im Browser durch.
SSH (empfohlen). Dies funktioniert bei jedem Projekt, und es wird nichts im Klartext gespeichert.
- Öffnen
https://code.champrep.com/-/settings/ssh_keys. - Fügen Sie Ihren öffentlichen Schlüssel ein, zum Beispiel den Inhalt von
~/.ssh/id_ed25519.pub. - Überprüfen Sie den Schlüssel und die Verbindung:
champrep code ssh-keys lsgit ls-remote git@code.champrep.com:acme/web.git HEADHTTPS mit einem persönlichen Zugriffstoken.
- Öffnen
https://code.champrep.com/-/settings/tokens. - Erstellen Sie ein Token mit dem Geltungsbereich
read_repositoryoderwrite_repository, falls Sie einen Push durchführen. Legen Sie ein Ablaufdatum fest. - Lassen Sie den Anmeldedaten-Speicher von Git das Token in Ihrem System-Schlüsselbund aufbewahren:
# macOSgit config --global credential.https://code.champrep.com.helper osxkeychain# Windows (Git Credential Manager)git config --global credential.https://code.champrep.com.helper manager# Linux with libsecret (needs git-credential-libsecret, see below)git config --global credential.https://code.champrep.com.helper libsecretUnter Linux ist die libsecret Der Helfer funktioniert nur, wenn der git-credential-libsecret
Das Programm ist installiert. Viele Distributionen installieren es nicht zusammen mit Git. Installieren Sie es über die Pakete Ihrer Distribution oder kompilieren Sie es aus dem Git-Quellcode.
contrib/credential/libsecret Ordner. Überprüfen Sie dies mit
command -v git-credential-libsecret. Ohne Schlüsselbund sollten Sie den store
Hilfsprogramm, das das Token in ~/.git-credentials im Klartext. Verwenden Sie
cache --timeout=3600 stattdessen, das das Token ausschließlich im Arbeitsspeicher hält, oder verwenden Sie SSH.
Klonen Sie anschließend ein Projekt manuell. Git fragt nach einem Benutzernamen (jeder Wert ist zulässig) und einem Passwort (fügen Sie das Token ein), und der Anmeldedatenspeicher speichert diese:
git clone https://code.champrep.com/acme/web.gitVon nun an verwenden Git und champrep code clone Verwenden Sie das gespeicherte Token. Geben Sie niemals ein Token in eine Remote-URL wie https://user:TOKEN@…: Git schreibt die URL in
.git/config, und jeder, der diese Datei oder Ihren Shell-Verlauf liest, kann es nutzen. champrep code clone lehnt Klonadressen ab, die Anmeldedaten enthalten.
Alle meine Projekte klonen
Abschnitt betitelt „Alle meine Projekte klonen“Klonen Sie jedes Projekt, an dem Sie direkt oder über eine Gruppe beteiligt sind, in
~/src. Jedes Projekt wird unter seinem eigenen Namensraum abgelegt, zum Beispiel
~/src/acme/platform/api.
champrep code clone --membership --dest ~/src --sshWeitere Optionen:
champrep code clone --owned --dest ~/src --ssh # projects where your role is Ownerchamprep code clone --all --dest ~/src --ssh # also public and internal projects you can seechamprep code clone acme/web acme/api --dest ~/src # just these projectsSehen Sie sich zunächst den Plan an. Ein Testlauf listet jedes Projekt auf und zeigt, was passieren würde, ohne dass etwas verändert wird:
champrep code clone --membership --dest ~/src --dry-run
Klonen Sie eine Gruppe mit ihren Untergruppen
Abschnitt betitelt „Klonen Sie eine Gruppe mit ihren Untergruppen“champrep code clone --group acme --dest ~/src --ssh # the group's own projectschamprep code clone --group acme --include-subgroups --dest ~/src --ssh # and every subgroupchamprep code clone --group acme --include-subgroups --archived --dest ~/src --ssh # archived projects too--parallel N legt fest, wie viele Klone gleichzeitig ausgeführt werden (Standardwert 4, maximal 16). Archivierte Projekte werden ausgelassen, es sei denn, Sie fügen --archived. --search TEXT
behält nur Projekte bei, deren Name oder Pfad den Text enthält.
Halten Sie einen lokalen Spiegel auf dem neuesten Stand
Abschnitt betitelt „Halten Sie einen lokalen Spiegel auf dem neuesten Stand“Führen Sie denselben Befehl erneut aus mit --update. Es klont neue Projekte und aktualisiert die bereits vorhandenen:
champrep code clone --group acme --include-subgroups --dest ~/src --ssh --updateFür jeden vorhandenen Klon gilt: --update prüft zunächst, ob seine origin ist das Projekt, gekennzeichnet durch seine HTTPS- oder SSH-Adresse. Ein Klon eines anderen Repositorys unter diesem Pfad wird gemeldet als mismatch (fehlgeschlagen) und unbeachtet gelassen. Anschließend wird der Befehl ausgeführt
git fetch --prune sowie eine „Fast-Forward-Only“-Zusammenführung des aktuellen Zweigs. Lokale Arbeitsdaten werden niemals überschrieben:
- Ein Zweig, der vom Hauptzweig abgewichen ist, wird als fehlgeschlagen gemeldet, und Sie führen die Zusammenführung oder das Rebase selbst durch;
- Ein „detached HEAD“ oder ein Zweig ohne Upstream wird lediglich abgerufen und als
no-upstream.
Ohne --update… werden vorhandene Klone übersprungen.
Der Befehl endet mit einer Zusammenfassung und wird beendet 1 Sollte ein Projekt fehlschlagen, kann ein geplanter Job Sie benachrichtigen:
# crontab: refresh the mirror every night at 02:000 2 * * * champrep code clone --group acme --include-subgroups --dest "$HOME/src" --ssh --update >>"$HOME/src/.mirror.log" 2>&1Skriptvariante mit Auflistung der Fehler:
champrep code clone --membership --dest ~/src --ssh --update --json \ | jq -r '.[] | select(.status == "failed") | "\(.project): \(.error)"'Die JSON-Statusmeldungen lauten cloned, updated, up_to_date, no_upstream,
skipped, failed (mit "reason": "mismatch" (für einen Klon eines anderen Repositorys), interrupted und not_started nach Strg-C und mit
--dry-run, would_clone, would_update und would_skip.
champrep code clone Es werden niemals Eingabeaufforderungen angezeigt, da mehrere Klonvorgänge gleichzeitig ablaufen. `git` läuft mit GIT_TERMINAL_PROMPT=0. SSH läuft mit BatchMode=yesDaher werden weder Passwort noch Passphrase noch Fragen zum Hostschlüssel abgefragt, es sei denn, Sie legen eigene fest
GIT_SSH_COMMAND oder core.sshCommand. Führen Sie vor einem Massenklon über SSH zwei Schritte durch:
- Laden Sie Ihren Schlüssel in
ssh-agent(ssh-add). - Stellen Sie einmalig manuell eine Verbindung her, um den Hostschlüssel zu akzeptieren (
git ls-remote git@code.champrep.com:acme/web.git HEAD).
Ein Projekt, für das Git keine Anmeldedaten benötigt, schlägt nicht fehl, weder über
could not read Username über HTTPS oder Permission denied (publickey) über SSH. Richten Sie die oben genannten Anmeldedaten ein und führen Sie den Befehl erneut aus.
Mit Strg-C wird der Vorgang ordnungsgemäß beendet. Es werden keine neuen Klone gestartet, die laufenden werden gestoppt (Git entfernt einen halbfertigen Klon), und die Zusammenfassung zeigt an, was erledigt wurde. Führen Sie den Befehl erneut aus, um fortzufahren: Abgeschlossene Klone werden übersprungen.
Nur https:// und die SSH-Adressen auf dem CHAMPREPCode-Host werden geklont, und Git läuft, wobei alle anderen Transportprotokolle deaktiviert sind.
Pipelines auflisten und die aktuellste auf einem Zweig überprüfen
Abschnitt betitelt „Pipelines auflisten und die aktuellste auf einem Zweig überprüfen“champrep code pipelines ls acme/web --limit 10champrep code pipelines ls acme/web --ref main --limit 1champrep code pipelines ls acme/web --status failedSkriptvariante: Ausgeben des Status der neuesten Pipeline auf main:
champrep code pipelines ls acme/web --ref main --limit 1 --json | jq -r '.[0] | "\(.id) \(.status)"'
Warten auf eine Pipeline
Abschnitt betitelt „Warten auf eine Pipeline“pipelines wait wartet, bis eine Pipeline abgeschlossen ist, und ihr Beendigungscode ist das Ergebnis: 0 Erfolg; 1 fehlgeschlagen, abgebrochen, übersprungen oder bei einem manuellen Auftrag angehalten; 8 läuft noch, wenn --timeout (Standard 60m) ist abgelaufen.
Warten Sie nach einem Push auf die Pipeline des von Ihnen gepushten Commits:
git pushchamprep code pipelines wait acme/web --sha "$(git rev-parse HEAD)" && ./deploy.sh--sha wartet darauf, dass Code die Pipeline für diesen Commit erstellt, und anschließend darauf, dass diese abgeschlossen wird. --sha HEAD funktioniert auch innerhalb des Repositorys. Vermeiden Sie --ref main
Unmittelbar nach einem Push. Es wird die aktuellste Pipeline auf dem Zweig zu diesem Zeitpunkt verwendet, was immer noch die Pipeline des vorherigen Commits sein kann, falls Code noch keine für Ihren Push erstellt hat – in diesem Fall würden Sie auf der falschen Pipeline bereitstellen.
champrep code pipelines wait acme/web --ref main # the newest pipeline on main nowchamprep code pipelines wait acme/web 9921 --timeout 30m # one pipelineFühren Sie eine Pipeline aus und warten Sie auf diese:
ID=$(champrep code pipelines run acme/web --ref main --yes --json | jq -r .id)champrep code pipelines wait acme/web "$ID"Der Fortschritt und die abschließende Statuszeile werden an stderr ausgegeben. Mit --json, stdout enthält die abgeschlossene Pipeline, und der Exit-Code bleibt unverändert:
champrep code pipelines wait acme/web "$ID" --json | jq -r '"\(.status) \(.web_url)"'Eine Pipeline, die einen manuellen Job erreicht, wie beispielsweise ein von Ihnen manuell gestartetes Deployment, bleibt dort stehen, bis eine Person eingreift. pipelines wait Beendet 1 mit einer entsprechenden Meldung. Starten Sie den Auftrag mit champrep code jobs playoder übergeben
--manual-ok um die Pipeline als abgeschlossen zu werten (Beenden 0). Ein geplanter (verzögerter) Job startet von selbst, sodass die Wartezeit währenddessen fortgesetzt wird.
Um stattdessen einen einzelnen Job zu überwachen, verfolgen Sie dessen Protokoll. Der Befehl kehrt zurück, sobald der Job abgeschlossen ist und beendet wird 1 Wenn der Auftrag fehlgeschlagen ist oder abgebrochen wurde:
champrep code jobs log acme/web 4182 --follow
Pipeline wiederholen oder abbrechen
Abschnitt betitelt „Pipeline wiederholen oder abbrechen“champrep code pipelines retry acme/web 9921 --yes # reruns the failed and canceled jobschamprep code pipelines cancel acme/web 9921 --yes
Lesen Sie das Protokoll eines fehlgeschlagenen Auftrags, verfolgen Sie einen laufenden Auftrag, führen Sie einen Auftrag erneut aus
Abschnitt betitelt „Lesen Sie das Protokoll eines fehlgeschlagenen Auftrags, verfolgen Sie einen laufenden Auftrag, führen Sie einen Auftrag erneut aus“champrep code jobs ls acme/web --status failed --limit 5 # newest failed jobschamprep code jobs ls acme/web --pipeline 9921 --status failed # failed jobs of one pipelinechamprep code jobs log acme/web 4180 --tail 100 # end of a log of any sizechamprep code jobs log acme/web 4182 --follow # stream until the job endschamprep code jobs retry acme/web 4180 --yes # run a finished job againchamprep code jobs play acme/web 4190 --var DEPLOY=staging --yes # start a manual jobSkriptvariante, die die letzten 30 Zeilen jedes fehlgeschlagenen Jobs in einer Pipeline ausgibt:
for J in $(champrep code jobs ls acme/web --pipeline 9921 --status failed --json | jq -r '.[].id'); do echo "=== job $J" champrep code jobs log acme/web "$J" --tail 30done
Öffnen Sie einen Merge-Request und führen Sie die Zusammenführung durch
Abschnitt betitelt „Öffnen Sie einen Merge-Request und führen Sie die Zusammenführung durch“git push -u origin feature/loginchamprep code mr create acme/web --source feature/login --target main \ --title "Add login page" --remove-source-branch --yeschamprep code mr show acme/web 12 # merge status and head pipelinechamprep code mr approve acme/web 12 --yeschamprep code mr merge acme/web 12 --auto --squash --yes # merges when the pipeline succeedsSkriptvariante zur Erfassung der Nummer des neuen Merge-Requests:
IID=$(champrep code mr create acme/web --source feature/login --target main \ --title "Add login page" --yes --json | jq -r .iid)champrep code mr merge acme/web "$IID" --auto --yesWofür die Web-App benötigt wird. Zusammenführen oder Genehmigen in einen geschützter Zweig
ist eine Entscheidung, die nur Sie treffen können, wenn Sie bei CodeCHAMPREP im Browser angemeldet sind. Der Runner wird dannCLI mit needs your web session … (SESSION_REQUIRED) und Beenden Code 1. Eine erneuteCLI Anmeldung bei der ändert daran nichts. Öffnen Sie den Merge-Request im Browser und führen Sie dort die Zusammenführung oder Genehmigung durch. Ungeschützte Zweige funktionieren über die CLI.
Runner: Auflisten, anzeigen, wer online ist, markieren, anhalten und fortsetzen
Abschnitt betitelt „Runner: Auflisten, anzeigen, wer online ist, markieren, anhalten und fortsetzen“champrep code runners ls # project and group runners you managechamprep code runners ls --project acme/web # runners the project can use (Maintainer)champrep code runners ls --group acme # the group's runners (Owner)champrep code runners ls --status online # who is online nowchamprep code runners ls --status offline --active # offline but not paused: worth a lookchamprep code runners show 41 # status, online, tags, paused, machineschamprep code runners update 41 --add-tag docker --remove-tag old --yeschamprep code runners update 41 --tags linux,arm64 --yes # replace the whole listchamprep code runners update 41 --pause --yes # stop taking new jobschamprep code runners update 41 --resume --yes--add-tag und --remove-tag Lesen Sie die Tags des Runners und schreiben Sie die gesamte Liste zurück. Wenn jemand die Tags zwischen diesen beiden Schritten ändert, geht diese Änderung verloren; überprüfen Sie dies daher, wenn mehrere Personen einen Runner verwalten. runners show wenn mehrere Personen einen Runner verwalten.
Skriptvariante, bei der jeder Runner mit einem Tag vor der Wartung angehalten wird:
champrep code runners ls --tag gpu --active --limit 500 --json | jq -r '.[].id' \ | xargs -I{} champrep code runners update {} --pause --yesSie benötigen die Rolle „Maintainer“, um die Runner eines Projekts einzusehen und zu ändern, und die Rolle „Owner“ für die Runner einer Gruppe. Instanz-Runner sind für Instanzadministratoren vorgesehen (runners ls --all).
Registrieren Sie einen Runner
Abschnitt betitelt „Registrieren Sie einen Runner“Erstellen Sie einen Projekt- oder Gruppen-Runner über die CLI und verbinden Sie eine Maschine damit mit
champrep-code-runner. Das Token (ccrt_…) wird einmalig auf der Standardausgabe ausgegeben und niemals protokolliert. Die Erstellung erfordert stets --yes.
champrep code runners create --project acme/web --description "build box" \ --tags linux,docker --yes --json \ | jq -r .token \ | champrep-code-runner register --url https://code.champrep.com --token-stdin \ --executor docker --docker-image alpine:3.24Verwenden --group acme anstelle von --project für einen Gruppen-Runner (Sie benötigen die Berechtigung „Eigentümer“). Hinzufügen --no-untagged um nur mit Tags versehene Jobs zu berücksichtigen, und --protected , um ausschließlich geschützte Zweige und Tags auszuführen. Sie können den Runner auch in der Web-App erstellen, unter Einstellungen > CI/CD > Runner des Projekts oder der Gruppe. Siehe
einen Runner registrieren.
Die CLI kann weder das Token eines Runners zurücksetzen noch Instanzen-Runner erstellen. Führen Sie beides in der Web-App durch.
Runner-Farm
Abschnitt betitelt „Runner-Farm“
Nutzung und Guthaben prüfen
Abschnitt betitelt „Nutzung und Guthaben prüfen“champrep rf accounts show # the farm account, who it bills, the monthly ceilingchamprep rf usage # credits and minutes for the current periodchamprep rf usage --period 2026-10 # a past monthchamprep rf usage --json # { "balance": …, "usage": …, "period": "YYYY-MM" }
Pools anzeigen und sehen, was ansteht
Abschnitt betitelt „Pools anzeigen und sehen, was ansteht“champrep rf connections lschamprep rf pools lschamprep rf pools show pol_01HZX9K4champrep rf jobs ls --state waiting,heldSkriptvariante, die anzeigt, wie ausgelastet die einzelnen Pools sind:
champrep rf pools ls --json | jq -r '.pools[] | "\(.id) \(.state) \(.busy)/\(.max_concurrent)"'
Pool skalieren
Abschnitt betitelt „Pool skalieren“champrep rf pools update pol_01HZX9K4 --max-concurrent 8 --min-idle 2 --yes # scale upchamprep rf pools update pol_01HZX9K4 --max-concurrent 2 --min-idle 0 --yes # scale downchamprep rf pools update pol_01HZX9K4 --pause --yes # maintenancechamprep rf pools update pol_01HZX9K4 --resume --yeschamprep rf pools create --connection con_01HZX7 --name Builds \ --class build-4 --max-concurrent 4 --timeout 2h --yes # a new pool--min-idle Hält „Warm Runner“ bereit, sodass Jobs schneller starten; „Warm Runner“ verbrauchen jedoch Credits. Ihr Tarif begrenzt die Klassen und Limits, die Sie nutzen können.
Runner-Farm-Runner-Token, Connector-Geheimnisse und Paarungen verbleiben in der Web-App unter https://runners.champrep.com. Der CLI kann diese mit keinem Schlüssel erreichen.
CHAMPREP QA
Abschnitt betitelt „CHAMPREP QA“
Ein Repository aktivieren
Abschnitt betitelt „Ein Repository aktivieren“champrep qa repos available --provider code # CHAMPREP Code projects and their QA keysREPO="code:$(champrep code projects show acme/web --json | jq -r .id)"champrep qa repos activate "$REPO" --yes
Scannen und auf das Ergebnis warten
Abschnitt betitelt „Scannen und auf das Ergebnis warten“champrep qa scan "$REPO" --ref main --watch --yes # exits 1 when the scan or its gate failschamprep qa scans ls --repo "$REPO" --limit 5
Auflistung von Befunden mit hohem Schweregrad
Abschnitt betitelt „Auflistung von Befunden mit hohem Schweregrad“champrep qa findings ls --repo "$REPO" --severity critical,highchamprep qa findings ls --severity high --type secret # leaked secrets, whole workspacechamprep qa findings show QA-0970Skriptvariante:
champrep qa findings ls --repo "$REPO" --severity critical,high --json | jq -r '.[] | "\(.qaId) \(.title)"'
CI bei fehlgeschlagenem Qualitäts-Gate als fehlgeschlagen markieren
Abschnitt betitelt „CI bei fehlgeschlagenem Qualitäts-Gate als fehlgeschlagen markieren“champrep qa gates status Beenden 1 , wenn die Gating-Prüfung fehlschlägt, sodass er jeden Pipeline-Schritt absichern kann. In CHAMPREP Code (.chpcode-ci.yml):
qa-gate: stage: test image: alpine:3.20 variables: QA_REPO: "code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10" before_script: - apk add --no-cache curl - curl -fsSL https://cli.champrep.com/install.sh | sh - export PATH="$HOME/.local/bin:$PATH" script: # CHAMPREP_TOKEN is a masked, protected CI variable holding an API key # with the qa:read scope. - champrep qa gates status "$QA_REPO" --branch "$CI_COMMIT_REF_NAME"Derselbe Job funktioniert in einer GitLab .gitlab-ci.yml. Um zunächst zu scannen und anschließend eine Freigabe durchzuführen, geben Sie den Schlüssel an qa:write sowie:
script: - champrep qa scan "$QA_REPO" --ref "$CI_COMMIT_REF_NAME" --watch --timeout 20m --yesEin Scan verbraucht Ihr QA-Kontingent, daher führen viele Teams Scans nur auf dem Standard-Branch und bei Merge-Anfragen durch und wenden das Gate überall sonst an.
Verwendung von CLI in CI und Skripten
Abschnitt betitelt „Verwendung von CLI in CI und Skripten“Welche Anmeldedaten. Bitte nicht verwenden champrep auth login in CI. Erstellen Sie einen bereichsgebundenen API Schlüssel, während Sie inCLI einer Browsersitzung bei der angemeldet sind, und speichern Sie ihn als maskierte, geschützte CI-Variable mit dem Namen CHAMPREP_TOKEN. Die CLI verwendet diese Variable anstelle des Schlüsselbunds.
champrep keys create --name "CI: acme/web" --scope code:read_api --scope qa:read --expires-in-days 90| Was der Job tut | Gültigkeitsbereiche |
|---|---|
| Code lesen: Projekte, Pipelines, Jobprotokolle, Runner | code:read_api |
| Code ändern: Pipelines ausführen, Jobs wiederholen, MRs öffnen und zusammenführen, Runner aktualisieren | code:api |
| Lesen Sie „Runner Farm“ / „Pools ändern“ | runner_farm:read / runner_farm:write |
| QA-Prüfungen und Ergebnisse überprüfen / Scans starten, Repositorys aktivieren | qa:read / qa:write |
Gewähren Sie nur die Berechtigungen, die der Job benötigt. Ein Schlüssel darf keinen Zugriff auf die CHAMPREPCode-Verwaltung, die Anmeldedaten der Runner Farm oder auf irgendetwas haben, wofür Ihre Web- Sitzung erforderlich ist.
Keine Eingabeaufforderungen. Ohne Terminal wird jeder Befehl, der Änderungen bewirkt, abgelehnt, es sei denn, Sie übergeben --yes (-y), und es wird nichts gesendet. Fügen Sie --yes in jeden Schreibvorgang in einem Skript. champrep code clone erfordert keine Eingabeaufforderungen und benötigt keine
--yes.
Maschinenlesbare Ausgabe. Hinzufügen --json und analysieren Sie diese mit jq. Der Exit-Code bleibt unverändert bei --json. Analysieren Sie den für Menschen lesbaren Text nicht.
Exit-Codes.
| Code | Bedeutung | Typische Maßnahmen in der CI |
|---|---|---|
0 | Erfolg. | Weiter. |
1 | Fehler oder Zugriffsverweigerung: ein fehlgeschlagenes Gate, ein fehlgeschlagener Scan, eine Pipeline oder ein verfolgter Auftrag, der nicht erfolgreich war, ein fehlgeschlagener Klon, kein Zugriff auf das Element, nicht in Ihrem Tarif enthalten, Ihre Rolle, eine Entscheidung, die Ihre Websitzung erfordert, oder ein fehlendes --yes. | Den Job als fehlgeschlagen markieren; die Meldung lesen. |
3 | Sie sind nicht angemeldet, oder der Schlüssel ist ungültig oder wurde widerrufen. | Beheben CHAMPREP_TOKEN. |
4 | Dem Schlüssel fehlt ein Geltungsbereich. | Fügen Sie den Geltungsbereich zum Schlüssel hinzu. |
5 | Ratenbegrenzung oder Kapazität. | Bitte versuchen Sie es später erneut. |
6 | Netzwerkausfall. | Bitte versuchen Sie es erneut. |
7 | Ausfall des Gateways oder des Dienstes. | Bitte versuchen Sie es später erneut. |
8 | pipelines wait ist abgelaufen --timeout; die Pipeline läuft noch. | Bitte warten Sie erneut oder lösen Sie einen Fehler aus --timeout. |
Siehe die Befehlsreferenz und API Schlüssel für die Automatisierung.