Lass deine Merge Requests in GitLab zusätzlich von Codex überprüfen. Codex prüft den Diff des Merge Requests, beachtet die Vorgaben in deinem Repository und veröffentlicht ein reguläres GitLab-Review, das sich auf schwerwiegende Probleme konzentriert.
Die GitLab-Integration für Code Review ist als Beta in allen ChatGPT-Plänen verfügbar. Sie läuft in Codex Cloud. Repository-Aktionen, die du aus der GitHub-Integration der Desktop-App kennst, etwa Pull Request erstellen, sind in dieser Beta nicht verfügbar.
Wenn GitLab in der Repository-Auswahl erscheint, während du eine Cloud-Umgebung erstellst, wähle ein GitLab.com-Projekt aus, auf das dein verbundenes Konto zugreifen kann. Für Aufgaben und Reviews, die GitLab auslöst, richte die Webhooks wie unten beschrieben ein.
Voraussetzungen
Du brauchst:
- Ein verbundenes GitLab-Konto. Für GitLab.com nutzt du das Standardverfahren zum Verbinden deines Kontos. Für selbstverwaltete GitLab-Instanzen oder GitLab Dedicated muss die Workspace-Administration eine Vorlage einrichten.
- Eine
AGENTS.md-Datei, wenn Codex beim Review Vorgaben für dein Repository beachten soll.
Code Review mit Codex einrichten
GitLab-Verbindung und Konto für Codex-Reviews einrichten
Wenn du GitLab.com nutzt, verbinde dein GitLab-Konto in Codex, sobald du GitLab mit ChatGPT verbunden hast. Bei selbstverwaltetem GitLab oder GitLab Dedicated sollte jede Person, die Reviews durchführt, ihr Konto verbinden, sobald die Vorlage der Workspace-Administration veröffentlicht ist.
Öffne für selbstverwaltetes GitLab oder GitLab Dedicated Codex Cloud → Einstellungen → Konnektoren. Wer den Workspace verwaltet, kann Codex ein Dienstkonto erstellen lassen oder den persönlichen Zugriffstoken eines bestehenden Dienstkontos speichern.
Konto von Codex erstellen lassen
Wähle unter Codex Cloud → Einstellungen → Konnektoren die App für deinen selbstverwalteten GitLab-Host oder deinen GitLab-Dedicated-Host. Wähle dann Dienstkonto einrichten → Dienstkonto erstellen. Wenn du als Workspace-Admin das Setup abschließt, brauchst du Administrationsrechte für die GitLab-Instanz. Wähle Ausgewählte Gruppen oder Nur ausgewählte Projekte, lege fest, wo Codex arbeiten soll, und erstelle das Konto. Bei der Gruppenoption erhält das Konto in jeder ausgewählten Gruppe die Rolle Developer. Die Projekte und Untergruppen erben diese Berechtigung. Bei der Projektoption gilt die Rolle Developer nur für die einzeln ausgewählten Projekte. Codex erstellt für die Instanz das Dienstkonto ChatGPT Codex Connector und einen persönlichen Zugriffstoken mit dem Geltungsbereich api.
Bestehendes Konto verwenden
Erstelle in GitLab ein Dienstkonto oder wähle ein bestehendes aus. Weise ihm die Rolle Developer nur in den Gruppen oder Projekten zu, in denen Codex arbeiten soll. Wähle auf der Seite Dienstkonten das Konto und dann Zugriffstoken verwalten → Neuen Token hinzufügen, um einen persönlichen Zugriffstoken zu erstellen. Wähle den Geltungsbereich api und ein Ablaufdatum, das mindestens 30 Tage in der Zukunft liegt. Wähle anschließend in Codex Bestehendes Dienstkonto verwenden, füge den Token ein und wähle Token speichern. Codex verschlüsselt den Token beim Speichern und zeigt ihn danach nicht mehr an.
Token des Dienstkontos verwalten
Wenn du den Workspace verwaltest, kannst du das Dienstkonto unter Codex Cloud → Einstellungen → Konnektoren verwalten. Hat Codex das Konto erstellt, kannst du den aktuellen Token widerrufen und einen neuen generieren. Bei einem bestehenden Konto kannst du den gespeicherten Token in Codex ersetzen oder entfernen und ihn bei Bedarf separat in GitLab widerrufen. Codex kann erst auf GitLab-Aktivitäten reagieren, wenn ein gültiger Token konfiguriert ist.
Festlegen, wie GitLab-Ereignisse Codex erreichen
Projektumgebung für Programmieraufgaben oder ein projektspezifisches Setup erstellen
Wähle unter Codex Cloud → Einstellungen → Umgebungen das GitLab-Projekt aus und erstelle eine Projektumgebung, wenn Codex für dieses Projekt Code schreiben oder ausführen soll. Das ist zum Beispiel nötig, wenn Codex Dateien bearbeiten, Änderungen committen oder Updates in den Branch eines Merge Requests pushen soll. Erstelle auch dann eine Projektumgebung, wenn ein Review projektspezifische Secrets, Netzwerkzugriff oder Setup-Befehle benötigt.
Bei GitLab.com brauchst du auch zum Aktivieren von Codex-Reviews eine Projektumgebung.
Aktiviere beim Erstellen der Umgebung Codex-Aktivität aus GitLab aktivieren. Damit installierst du den Projekt-Webhook, der Ereignisse zu Merge Requests, Kommentaren und Issues an Codex übermittelt. Zum Erstellen des Projekt-Webhooks brauchst du die Rolle Maintainer oder Owner, Administrationsrechte oder eine benutzerdefinierte Rolle, mit der du Projekt-Webhooks verwalten kannst. Signierte Projekt- und Gruppen-Webhooks setzen GitLab 19.0 oder neuer voraus. Prüfe bei selbstverwaltetem GitLab 19.0, ob das Feature-Flag webhook_signing_token aktiviert ist. Es ist standardmäßig aktiviert und wurde in GitLab 19.1 entfernt.
GitLab-Aktivität für Codex-Reviews in allen Projekten einer Gruppe aktivieren
Wenn du den Workspace verwaltest und selbstverwaltetes GitLab oder GitLab Dedicated nutzt, kannst du unter Umgebungen → GitLab-Aktivität → Gruppen verwalten Codex-Reviews für eine Gruppe und ihre Untergruppen aktivieren. Codex installiert einen Gruppen-Webhook für alle Projekte dieser Gruppe und ihrer Untergruppen. Das verbundene GitLab-Konto muss in der Gruppe die Rolle Owner haben. Gruppen-Webhooks setzen GitLab Premium oder Ultimate sowie GitLab 19.0 oder neuer voraus.
Wenn du die Gruppenaktivität aktivierst, sind Code-Reviews möglich. Projektumgebungen werden dabei nicht erstellt. Erstelle eine Projektumgebung, wenn GitLab Programmieraufgaben auslösen soll, bei denen Codex etwa Dateien bearbeitet, Befehle ausführt, Änderungen committet oder Updates in den Branch eines Merge Requests pusht.
Richtlinien für Code-Reviews konfigurieren
Lege die Richtlinien in den Review-Einstellungen von Codex fest. Wähle dein Repository aus und aktiviere Automatische Überprüfung im Bereich Code überprüfen. Unter Überprüfung legst du fest, wessen Merge Requests Codex prüft. Unter Auslöser bestimmst du, wann die Reviews starten. Repository-Einstellungen können deine persönlichen Standardeinstellungen überschreiben.
Codex-Review anfordern
- Erwähne
@codex reviewin einem Kommentar zum Merge Request. - Warte, bis Codex mit 👀 reagiert und ein Review veröffentlicht.
Wie andere Teammitglieder eröffnet Codex in GitLab Diskussionen und hinterlässt Kommentare zum Merge Request. Manuell angeforderte Reviews können standardmäßig Probleme der Prioritäten P0, P1 und P2 aufzeigen. Automatische Reviews konzentrieren sich auf P0 und P1.
Automatische Reviews aktivieren
Damit Codex passende Merge Requests automatisch prüft, aktiviere in den Codex-Einstellungen Automatische Überprüfungen. Wähle die Richtlinie für das GitLab-Repository und einen der Auslöser Beim Öffnen eines Merge Requests, Bei jedem Push oder Intelligenter Auslöser (experimentell). Wenn das Ereignis im Merge Request zur Richtlinie und zum Auslöser passt, startet Codex das Review auch ohne einen Kommentar mit @codex review.
Die GitLab-Aktivität muss über einen Projekt-Webhook oder den Webhook einer übergeordneten Gruppe aktiviert sein. Bei selbstverwaltetem GitLab oder GitLab Dedicated braucht das konfigurierte Dienstkonto außerdem Schreibzugriff auf das Projekt. Ist eine Projektumgebung konfiguriert, nutzt Codex sie. Ist die Aktivität bereits für eine übergeordnete Gruppe aktiviert, gilt das auch für die untergeordneten Projekte.
Festlegen, was Codex überprüft
Codex sucht in deinem Repository nach AGENTS.md-Dateien und befolgt die jeweils geltenden Review-Regeln. Füge der Datei, die im Verzeichnisbaum am nächsten am betreffenden Code liegt, einen Abschnitt ## Code Review Rules hinzu. Mit ###-Überschriften kannst du bei Bedarf verwandte Prüfungen gruppieren.
Bei einem Dienst zur Auswertung von Experimenten kann eine Regel beispielsweise verhindern, dass das Verhalten nach dem ersten Kontakt mit einer Variante die Zusammensetzung der Vergleichsgruppe verändert:
## Code Review Rules
### Kohorten in Experimenten
- Filtere beim Vergleich von Versuchsvarianten nicht nach dem Verhalten nach dem Kontakt mit einer Variante. Das gilt auch für Konversion und Nutzerbindung.
Bilde die Kohorten anhand der Variantenzuweisung oder des tatsächlichen Kontakts mit der Variante. Weise die Konversion als Ergebnis aus.
Lege Regeln für das gesamte Repository in der AGENTS.md im Stammverzeichnis ab. Regeln für einen einzelnen Dienst gehören in eine Datei im jeweiligen Unterverzeichnis, etwa services/experiment_reporting/AGENTS.md. Für jede geänderte Datei berücksichtigt Codex sowohl die Vorgaben aus dem Stammverzeichnis als auch die spezifischeren Regeln, die für diese Datei gelten. Bei Änderungen, die den Dienst nicht betreffen, brauchst du dessen Besonderheiten also nicht zu erläutern.
Beginne mit zwei oder drei knappen Regeln für Prüfungen, die dein Team in Reviews häufig erklären muss. Achte dabei auf Folgendes:
- Konzentriere dich auf Verhalten, das für dieses Repository wichtig ist und spürbare Folgen hat. Beschreibe, auf welche Kompatibilitätsanforderung, welche Grenze beim Datenzugriff oder welchen unsicheren Nebeneffekt Codex hinweisen soll und warum das wichtig ist.
- Nenne das sichere Vorgehen oder die Ausnahme. Gib Codex genug Kontext, um ein tatsächliches Problem von erwartetem Verhalten zu unterscheiden.
- Formuliere Regeln mit klarem Geltungsbereich, die langfristig gültig bleiben. Beschreibe das gewünschte Ergebnis, statt Funktionsnamen zu nennen, die sich ändern können. Lege die Regeln dort ab, wo der zugehörige Code liegt.
- Überlasse mechanische Prüfungen der CI. Halte Formatierung, Linting und andere deterministische Prüfungen aus den Review-Regeln heraus.
Öffne einen repräsentativen Merge Request und fordere mit @codex review ein Review an. Passe die Regeln anhand der gemeldeten Probleme und des Feedbacks an. Grenze Regeln ein oder entferne sie, wenn sie zu irrelevanten Hinweisen führen.
Die Review-Regeln geben Codex vor, worauf es achten soll. Sie ersetzen weder Tests noch Branch-Schutzregeln oder erforderliche Genehmigungen.
Wenn Codex bei einem einzelnen Review auf etwas Bestimmtes achten soll, ergänze deinen Kommentar zum Merge Request entsprechend:
@codex review Prüfe die Datenbankmigration auf Probleme.
Gemeldete Probleme beheben
Damit Codex gemeldete Probleme beheben kann, braucht es eine konfigurierte Projektumgebung. Die Gruppenaktivität allein ermöglicht Reviews, aber keine Programmieraufgaben. Hat das Projekt eine Umgebung, kannst du Codex mit einem weiteren Kommentar im selben Merge Request bitten, ein Problem zu beheben:
@codex Behebe das P1-Problem.
Codex startet einen Cloud-Chat der Vorgängerversion mit dem Merge Request als Kontext. Mit der entsprechenden Berechtigung kann Codex die Korrektur in den Branch pushen.
Codex mit anderen Aufgaben beauftragen
Auch für andere Programmieraufgaben braucht Codex eine konfigurierte Projektumgebung. Die Gruppenaktivität allein ermöglicht nur Reviews. Wenn du @codex in einem Kommentar erwähnst und etwas anderes als review angibst, startet Codex einen Cloud-Chat der Vorgängerversion mit deinem Merge Request als Kontext.
@codex Behebe die CI-Fehler.
Probleme bei Code-Reviews beheben
Wenn Codex nicht reagiert oder kein Review veröffentlicht:
- Prüfe, ob die richtige GitLab-App ausgewählt ist. Wenn du ein projektspezifisches Setup nutzt, prüfe auch, ob dem Projekt die vorgesehene Cloud-Umgebung in Codex zugeordnet ist.
- Prüfe, ob die Aktivität für das Projekt oder eine übergeordnete Gruppe aktiviert ist. Öffne in GitLab Webhooks → Letzte Ereignisse und prüfe, ob GitLab Ereignisse zu Merge Requests und Kommentaren erfolgreich zustellt.
- Prüfe bei selbstverwaltetem GitLab oder GitLab Dedicated, ob der Projekt- oder Gruppen-Webhook signiert ist, die SSL-Verifizierung aktiviert ist und die Instanz GitLab 19.0 oder neuer verwendet. Prüfe bei selbstverwaltetem GitLab 19.0, ob das Feature-Flag
webhook_signing_tokenaktiviert ist. Repariere Webhooks, die nach Fehlern automatisch deaktiviert wurden. - Wenn du bei selbstverwaltetem GitLab oder GitLab Dedicated ein bestehendes Dienstkonto nutzt, prüfe, ob dessen persönlicher Zugriffstoken aktiv ist und den Geltungsbereich
apihat. Hat Codex das Dienstkonto erstellt, prüfe in den Konnektoreinstellungen von Codex, ob das Konto richtig konfiguriert und die Aktivität für das Projekt oder die Gruppe aktiviert ist. - Prüfe bei selbstverwaltetem GitLab oder GitLab Dedicated, ob das Dienstkonto des Workspace im Projekt oder in einer übergeordneten Gruppe die Rolle Developer hat. Die Berechtigung des verbundenen GitLab-Kontos allein reicht nicht aus, damit Codex Reviews und Reaktionen veröffentlichen kann. Die Gruppenmitgliedschaft wird vererbt. Die Aktivierung der GitLab-Aktivität und die Zugriffsrechte des Dienstkontos werden getrennt verwaltet.
- Prüfe, ob Code Review oder Automatische Überprüfungen aktiviert ist und der Merge Request zur Repository-Richtlinie und zum gewählten Auslöser passt.
- Verwende
@codex review.