GitLab-CI-Konfigurationsgenerator
Wähle eine Vorlage und gestalte deine Pipeline per Formular: Stages, ein Standard-Image, ein Cache auf Basis der Lock-Datei und Jobs mit Skripten, Artifacts, JUnit-Berichten, Needs und Rules. Die .gitlab-ci.yml aktualisiert sich beim Tippen und wird auf häufige Fehler wie unbekannte Stages oder fehlerhafte Needs geprüft.
Zuletzt aktualisiert:
.gitlab-ci.yml
Anleitung: GitLab-CI-Konfigurationsgenerator
- Wähle eine Vorlage wie Node.js, Python oder Docker-Image, um mit sinnvollen Jobs zu starten.
- Lege die Pipeline-Grundlagen fest: die Liste der Stages, das Standard-Image, den Cache und globale Variablen.
- Bearbeite die Jobs: Name, Stage, Skriptzeilen und wann sie laufen. Öffne Weitere Optionen für Services, Needs, Berichte und Environments.
- Füge Jobs hinzu, dupliziere, sortiere oder lösche sie und sieh zu, wie sich Stage-Übersicht und YAML aktualisieren.
- Behebe alle roten Hinweise, kopiere oder lade die Datei herunter und committe sie als .gitlab-ci.yml im Stammverzeichnis des Repositorys.
Wichtige Schlüsselwörter der .gitlab-ci.yml
| Schlüsselwort | Funktion | Beispiel |
|---|---|---|
stages | Reihenfolge, in der Gruppen von Jobs laufen | [test, build, deploy] |
default | Einstellungen, die jeder Job erbt, etwa image, cache und interruptible | image: node:20-alpine |
variables | Umgebungsvariablen für alle Jobs oder einen Job | PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip" |
script | Shell-Befehle, die der Job ausführt (erforderlich) | - npm test |
before_script | Befehle, die vor script in derselben Shell laufen | - docker login … |
services | Zusätzliche Container, die während des Jobs verfügbar sind | postgres:16, docker:27-dind |
cache | Dateien, die zwischen Pipelines wiederverwendet werden, um Downloadzeit zu sparen | key: {files: [package-lock.json]} |
artifacts | Job-Ausgabe, die an spätere Jobs übergeben und zum Download aufbewahrt wird | paths: [dist/], expire_in: 1 week |
needs | Starten, sobald diese Jobs fertig sind, unabhängig von der Stage-Reihenfolge | needs: [build] |
rules | Entscheidet, ob und wie ein Job zu einer Pipeline hinzugefügt wird | - if: $CI_COMMIT_TAG |
environment | Deployments in eine Umgebung nachverfolgen | name: production |
workflow | Regeln, ob die gesamte Pipeline erstellt wird | Doppelte MR- und Branch-Pipelines vermeiden |
Nützliche vordefinierte CI/CD-Variablen
| Variable | Wert |
|---|---|
$CI_DEFAULT_BRANCH | Der Standard-Branch des Projekts, meist main |
$CI_COMMIT_BRANCH | Branch-Name in Branch-Pipelines (in Merge-Request- oder Tag-Pipelines nicht gesetzt) |
$CI_COMMIT_TAG | Tag-Name, nur in Tag-Pipelines |
$CI_PIPELINE_SOURCE | Was die Pipeline gestartet hat: push, merge_request_event, schedule, web … |
$CI_COMMIT_REF_SLUG | Branch- oder Tag-Name, sicher gemacht für URLs und Cache-Schlüssel |
$CI_COMMIT_SHORT_SHA | Die ersten 8 Zeichen des Commit-SHA, praktisch als Image-Tag |
$CI_PROJECT_DIR | Vollständiger Pfad, in den das Repository im Job geklont wird |
$CI_REGISTRY_IMAGE | Adresse des Images in der Container-Registry des Projekts |
Tipps für schnellere, sicherere Pipelines
- Lege Image-Versionen fest (
node:20-alpine, nichtnode:latest), damit ein neues Upstream-Release eine Pipeline nicht über Nacht kaputt machen kann. - Nutze
needs, damit unabhängige Jobs parallel laufen, statt auf ganze Stages zu warten. - Gib Artifacts ein
expire_in, damit alte Build-Ausgaben dein Speicherkontingent nicht füllen. - Veröffentliche Testergebnisse mit
artifacts:reports:junit, um Fehler direkt in Merge Requests zu sehen. - Lass Deploy-Jobs auf dem Standard-Branch laufen und mach Produktions-Deploys
manual, bis du der Pipeline vertraust.
Häufige Fragen
Wohin kommt die Datei .gitlab-ci.yml?
Committe sie mit genau diesem Namen ins Stammverzeichnis deines Repositorys. GitLab erkennt sie beim nächsten Push und startet eine Pipeline mit den Shared- oder Projekt-Runnern, die dem Projekt zur Verfügung stehen. Du kannst sie in GitLab unter Build, Pipeline-Editor in der Vorschau ansehen und validieren.
Was ist der Unterschied zwischen Stages und Needs?
Stages laufen nacheinander: Jeder Job einer Stage wartet, bis alle Jobs der vorherigen Stage fertig sind. Mit needs kann ein Job starten, sobald die von ihm aufgeführten Jobs fertig sind, auch wenn andere Jobs früherer Stages noch laufen – das verkürzt Pipelines. Ein Job kann nur Jobs derselben oder einer früheren Stage benötigen.
Worin unterscheidet sich Caching von Artifacts?
Ein Cache beschleunigt Jobs, indem heruntergeladene Abhängigkeiten wie .npm oder .m2 zwischen Pipelines wiederverwendet werden, ist aber nicht garantiert und kann fehlen. Artifacts sind die Ausgaben eines Jobs, etwa ein dist-Ordner oder ein Testbericht, werden zuverlässig an spätere Jobs derselben Pipeline übergeben und bis zum Ablauf zum Download aufbewahrt.
Warum cache:key:files mit einer Lock-Datei verwenden?
Mit key: files bildet GitLab den Cache-Schlüssel aus dem Inhalt der aufgeführten Dateien, etwa package-lock.json. Der Cache wird wiederverwendet, bis sich die Abhängigkeiten ändern, und dann automatisch neu erstellt. Du kannst bis zu zwei Dateien angeben.
Was bewirken die Workflow-Rules?
Ohne sie kann ein Push auf einen Branch mit offenem Merge Request zwei Pipelines starten: eine Branch-Pipeline und eine Merge-Request-Pipeline. Die generierten Workflow-Rules führen Merge-Request-Pipelines aus, überspringen Branch-Pipelines, solange ein Merge Request offen ist, und führen Pipelines für andere Branches und Tags weiterhin aus.
Wie verwende ich Secrets in der Pipeline?
Schreib keine Passwörter oder Tokens in die .gitlab-ci.yml. Füge sie in GitLab unter Einstellungen, CI/CD, Variablen hinzu, markiere sie als maskiert und geschützt und verwende sie in Skripten als $MY_TOKEN. Vordefinierte Variablen wie $CI_REGISTRY_USER und $CI_REGISTRY_PASSWORD werden für die Container-Registry des Projekts automatisch bereitgestellt.
Warum braucht ein Job ein Skript?
Jeder normale Job muss einen script-Abschnitt mit mindestens einem Befehl haben; andernfalls lehnt GitLab die Konfiguration ab. Die einzigen Ausnahmen sind Trigger-Jobs, die eine andere Pipeline starten. Versteckte Jobs, deren Namen mit einem Punkt beginnen, sind Vorlagen für extends und laufen nicht.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.