Codex GitHub-Integration

Codex lässt sich tief in GitHub integrieren, sodass du Code direkt in Pull Requests überprüfen kannst. Dieser Abschnitt beschreibt, wie du die GitHub-Integration konfigurierst und verwendest.

Funktionsübersicht

Mit der GitHub-Integration kannst du:

  • Codex-Review direkt in einem PR-Kommentar anfordern
  • Jeden Pull Request automatisch überprüfen
  • Codex CI-Fehler beheben lassen
  • Codeänderungen überprüfen und Vorschläge machen
Ohne GitHub zu verlassen, antwortet Codex mit Review-Kommentaren wie ein Teammitglied.

GitHub-Integration einrichten

Voraussetzungen

  • Codex Cloud-Abonnement
  • GitHub-Konto

Konfigurationsschritte

  1. EinstellungenCodex Cloud
  2. Gehe zuCodex-Einstellungen
  3. Für das Repository aktivierenCode-ReviewFunktionen
  4. Codex autorisieren, auf deine Repositories zuzugreifen
Du musst Codex die Berechtigung erteilen, Repositories zu lesen und Pull Requests zu erstellen.

Code-Review anfordern

Manuelles Auslösen einer Überprüfung

Erwähne Codex in einem Pull-Request-Kommentar@codex review：

Review anfordern

# Gib dies im PR-Kommentar ein
@codex review

# Oder gib einen Review-Fokus an
@Codex-Überprüfung auf Sicherheitsregressionen

Codex-Antwort

Codex wird:

  1. Auf den PR reagieren (👀)
  2. Die Codeänderungen analysieren
  3. Review-Kommentare veröffentlichen
  4. Gefundene Probleme markieren (P0 und P1)
Codex wird Review-Kommentare zum PR veröffentlichen, genau wie ein menschlicher Reviewer.

Automatisches Review

In den Einstellungen aktivierenAutomatische Reviews：

  1. Gehe zuCodex-Einstellungen
  2. AktivierenAutomatische Reviews
  3. Automatisch ein Review abgeben, wenn ein neuer PR geöffnet wird

Review-Inhalte anpassen

Repository-Review-Richtlinien einrichten

Im RepositoryAGENTS.mdReview-Richtlinien hinzufügen:

Review-Richtlinien hinzufügen

## Review-Richtlinien

- PII (personenbezogene Daten) nicht protokollieren
- Verifizieren Sie, dass die Authentifizierungs-Middleware jede Route umschließt
- Auf SQL-Injection-Schwachstellen prüfen
- Sicherstellen, dass Fehlermeldungen keine sensiblen Informationen preisgeben

Modulspezifische Regeln

Spezifischere Review-Regeln in Unterverzeichnissen platzieren:

Modulspezifische Regeln

# src/payment/ modulspezifische Review-Regeln

## Zahlungsspezifische Reviews
- Überprüfen Sie, ob die Zahlungsabwicklung der PCI-Compliance entspricht
- Prüfen Sie auf ordnungsgemäße Betragsvalidierung
- Transaktionsprotokollierung sicherstellen
Spezifischere Regeln werden automatisch auf Codeänderungen im entsprechenden Modul angewendet.

Einmaliger Review-Fokus

Geben Sie einen Review-Fokus in einem Kommentar an:

Review-Fokus angeben

# Beispielkommentar
@codex review für Sicherheitsprobleme
@codex review für Performance-Regressionen
@codex review für Dokumentationsvollständigkeit

Weitere Aufgaben an Codex geben

Codex in einem Kommentar erwähnen@codex(nicht 'review') startet eine Cloud-Aufgabe:

Weitere Aufgaben

# Fix CI failures
@codex fix the CI failures

# Add tests
@codex add tests for the new API endpoints

# Refactor code
@codex refactor this function to use async/await
Die anderen Funktionen von Codex zu nutzen, ist so einfach wie das Erwähnen mit @ in einem Kommentar.

GitHub Actions Integration

Du kannst Codex auch in GitHub Actions verwenden:

GitHub Actions-Workflow

span style="color: green;">
name: Codex Review

on: [pull_request]

jobs:
  codex-review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: 运行 Codex Review
        run: |
          codex exec "Review code changes in this PR" --output review.md

      - name: Review veröffentlichen
        uses: actions/github-script@v7
        with:
          script: |
            const fs = require('fs');
            const review = fs.readFileSync('review.md', 'utf8');
            github.rest.pulls.createReview({
              owner: context.repo.owner,
              repo: context.repo.repo,
              pull_number: context.issue.number,
              body: review,
              event: 'COMMENT'
            });
Die Integration von Codex in deine CI/CD-Pipeline kann die Codeüberprüfung automatisieren.

Best Practices

Überprüfungsrichtlinien

  • Definiere die Überprüfungsstandards klar in AGENTS.md.
  • Lege spezifische Regeln für verschiedene Module fest
  • Gib Problemprioritäten an (P0/P1)

Automatisierung

  • Automatische Überprüfung für reguläre PRs aktivieren
  • Manuellen Auslöser für große Änderungen verwenden
  • In Verbindung mit automatisierten Workflows verwenden
Eine gute Konfiguration kann die Überprüfungen von Codex genauer und effizienter machen.

FAQ

F: Muss ich für die Codex-Überprüfung bezahlen?

Die GitHub-Integration erfordert ein Codex-Cloud-Abonnement.

F: Kann Codex auf private Repositories zugreifen?

Du musst Codex autorisieren, auf deine privaten Repositories zuzugreifen.

F: Kann ich einschränken, welche Repositories Codex überprüfen kann?

Ja, du kannst Repositories in den Einstellungen selektiv autorisieren.

F: Welche Schweregrade von Problemen markiert Codex?

Probleme werden standardmäßig als P0 (kritisch) und P1 (schwerwiegend) markiert.

Weitere Erweiterungen