Intégration GitHub de Codex

Codex s'intègre profondément à GitHub, ce qui vous permet d'examiner le code directement dans les pull requests. Cette section détaille comment configurer et utiliser l'intégration GitHub.

Aperçu des fonctionnalités

Avec l'intégration GitHub, vous pouvez :

  • Demander une revue Codex directement dans un commentaire de PR
  • Examiner automatiquement chaque pull request
  • Demander à Codex de corriger les échecs CI
  • Examiner les modifications de code et fournir des suggestions
Sans quitter GitHub, Codex répondra avec des commentaires de revue comme le ferait un coéquipier.

Configurer l'intégration GitHub

Prérequis

  • Abonnement Codex Cloud
  • Compte GitHub

Étapes de configuration

  1. ParamètresCodex Cloud
  2. Accédez àParamètres Codex
  3. Activer pour le dépôtRevue de codeFonctionnalités
  4. Autoriser Codex à accéder à vos dépôts
Vous devez autoriser Codex à lire les dépôts et à créer des pull requests.

Demander une revue de code

Déclencher manuellement une revue

Mentionner Codex dans un commentaire de pull request@codex review：

Demander une revue

# Saisissez ceci dans le commentaire de la PR
@codex review

# Ou spécifiez un focus de revue
@Revue Codex pour les régressions de sécurité

Réponse de Codex

Codex va :

  1. Réagir à la PR (👀)
  2. Analyser les modifications de code
  3. Publier des commentaires de revue
  4. Signaler les problèmes détectés (P0 et P1)
Codex publiera des commentaires de revue sur la PR, tout comme un relecteur humain.

Revue automatique

Activer dans les paramètresRevues automatiques：

  1. Accédez àParamètres Codex
  2. ActiverRevues automatiques
  3. Publier automatiquement une revue lorsqu'une nouvelle PR est ouverte

Personnaliser le contenu de la revue

Configurer les directives de revue du dépôt

Dans le dépôtAGENTS.mdajoutez des directives de revue :

Ajouter des directives de revue

## Directives de revue

- Ne journalisez pas de PII (informations personnelles identifiables)
- Vérifiez que le middleware d'authentification enveloppe chaque route
- Recherchez les vulnérabilités d'injection SQL
- Assurez-vous que les messages d'erreur ne divulguent pas d'informations sensibles

Règles spécifiques au module

Placez des règles de revue plus spécifiques dans les sous-répertoires :

Règles spécifiques au module

# src/payment/ règles de revue spécifiques au module

## Revues spécifiques aux paiements
- Vérifier que le traitement des paiements respecte la conformité PCI
- Vérifier la validation correcte du montant
- Assurer la journalisation des transactions
Des règles plus spécifiques sont automatiquement appliquées aux modifications de code dans le module correspondant.

Focus de revue ponctuelle

Spécifiez un focus de revue dans un commentaire :

Spécifier le focus de la revue

# Exemple de commentaire
@codex review pour problèmes de sécurité
@codex review pour régressions de performance
@codex review pour complétude de la documentation

Confier d'autres tâches à Codex

Mentionner Codex dans un commentaire@codex(pas 'review') lance une tâche cloud :

Autres tâches

# Corriger les échecs CI
@codex corrige les échecs CI

# Ajouter des tests
@codex ajoute des tests pour les nouveaux points de terminaison d'API

# Refactoriser le code
@codex refactorise cette fonction pour utiliser async/await
Utiliser les autres fonctionnalités de Codex est aussi simple que de le mentionner avec @ dans un commentaire.

Intégration GitHub Actions

Vous pouvez également utiliser Codex dans GitHub Actions :

Flux de travail GitHub Actions

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

on: [pull_request]

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

      - name: Exécuter la revue Codex
        run: |
          codex exec "Review code changes in this PR" --output review.md

      - name: Publier la revue
        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.repo.repo,
              body: review,
              event: 'COMMENT'
            });
L'intégration de Codex dans votre pipeline CI/CD peut automatiser la revue de code.

Bonnes pratiques

Directives de revue

  • Définissez clairement les normes de revue dans AGENTS.md.
  • Définissez des règles spécifiques pour différents modules
  • Spécifiez les priorités des problèmes (P0/P1)

Automatisation

  • Activez la revue automatique pour les PR régulières
  • Utilisez un déclenchement manuel pour les modifications importantes
  • Utilisez en complément des flux de travail automatisés
Une bonne configuration peut rendre les revues de Codex plus précises et efficaces.

FAQ

Q : Dois-je payer pour la revue Codex ?

L'intégration GitHub nécessite un abonnement Codex Cloud.

Q : Codex peut-il accéder aux dépôts privés ?

Vous devez autoriser Codex à accéder à vos dépôts privés.

Q : Puis-je restreindre les dépôts que Codex peut examiner ?

Oui, vous pouvez autoriser sélectivement des dépôts dans les paramètres.

Q : Quels niveaux de problèmes Codex signale-t-il ?

Les problèmes sont signalés comme P0 (critique) et P1 (majeur) par défaut.

autres extensions