Documentation ChatGPT
Français
Contact goolvyouyou@gmail.com

Examiner les pull requests GitHub avec Codex

Configurez la revue de code Codex pour les pull requests GitHub, demandez des revues avec @codex review, activez les revues automatiques et personnalisez les consignes de revue.

Utilisez la revue de code Codex pour bénéficier d’une nouvelle passe de revue à forte valeur ajoutée sur les pull requests GitHub. Codex examine le diff de la pull request, suit les consignes de votre dépôt et publie une revue de code GitHub standard axée sur les problèmes graves. Security Review, disponible en version préliminaire de recherche, fournit un examen plus approfondi des problèmes de sécurité potentiels d’une pull request.

Avant de commencer

Vérifiez que vous disposez des éléments suivants :

Configurer la revue de code Codex

Pour configurer les revues automatiques, vous devez disposer d’un dépôt GitHub connecté et d’une autorisation GitHub de push ou d’administration pour ses paramètres.

  1. Connectez votre dépôt GitHub à Codex.
  2. Accédez aux paramètres de Codex.
  3. Choisissez votre dépôt, puis activez Revue automatique sous Examiner le code.

Demander une revue à Codex

  1. Dans un commentaire de pull request, mentionnez @codex review.
  2. Attendez que Codex réagisse (👀) et publie une revue.

Codex publie une revue sur la pull request, comme le ferait un membre de votre équipe. Dans GitHub, Codex signale uniquement les problèmes P0 et P1 afin que les commentaires de revue restent centrés sur les risques hautement prioritaires.

Activer les revues automatiques

Pour activer les revues automatiques de vos pull requests, activez Revue automatique sous Préférences personnelles dans les paramètres de Codex. Choisissez quand les revues s’exécutent avec Déclencheur de revue. Cela s’applique aux dépôts où la revue de code est activée et ne nécessite aucun commentaire @codex review.

Personnaliser ce que Codex examine

Codex recherche les fichiers AGENTS.md dans votre dépôt et suit les règles de revue de code applicables. Ajoutez une section ## Code Review Rules dans le fichier le plus proche du code auquel les règles s’appliquent. Utilisez des titres ### pour regrouper les vérifications associées lorsque cela est utile.

Par exemple, un service de rapport d’expériences peut empêcher le comportement post-exposition de modifier une cohorte de comparaison :

## Code Review Rules

### Experiment cohorts

- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
  Safe path: build cohorts from assignment or exposure; report conversion as an outcome.

Placez les règles applicables à l’ensemble du dépôt dans le fichier AGENTS.md à la racine et les règles propres à un service dans un fichier imbriqué, tel que services/experiment_reporting/AGENTS.md. Codex applique les consignes de la racine ainsi que les consignes plus spécifiques couvrant chaque fichier modifié, afin que les modifications sans rapport n’aient pas à inclure le contexte propre au service.

Commencez par deux ou trois règles concises qui formalisent les vérifications souvent expliquées par les personnes chargées des revues. Règles utiles :

  • Concentrez-vous sur les comportements importants et propres au dépôt. Décrivez la contrainte de compatibilité, la limite des données ou l’effet secondaire dangereux à signaler, ainsi que son importance.
  • Indiquez la procédure sûre ou l’exception. Donnez à Codex suffisamment de contexte pour distinguer un véritable problème d’un comportement attendu.
  • Définissez des règles ciblées et durables. Privilégiez les résultats attendus plutôt que les noms de fonctions susceptibles de changer, et placez les consignes à proximité du code auquel elles s’appliquent.
  • Réservez les vérifications mécaniques à la CI. N’incluez pas la mise en forme, le linting ni les autres vérifications déterministes dans les règles de revue.

Ouvrez une pull request représentative et demandez une revue avec @codex review. Affinez les règles selon les constats et les retours obtenus, puis limitez ou supprimez les consignes qui génèrent du bruit.

Les règles de revue de code guident Codex ; elles ne remplacent pas les tests, les protections de branches ni les approbations obligatoires.

Pour une demande ponctuelle, ajoutez-la au commentaire de votre pull request :

@codex review for issues in the database migration

Security Review

Security Review est une revue supplémentaire destinée aux clients qui souhaitent accorder une attention particulière aux problèmes de sécurité dans les pull requests. Elle examine plus en profondeur que Code Review les risques propres à la sécurité en analysant le diff de la pull request, le contexte pertinent du dépôt ainsi que les modèles de menaces ou les consignes de sécurité configurés.

Code Review peut également détecter des problèmes liés à la sécurité dans le cadre de sa revue générale. Il peut donc arriver que les constats de Code Review et de Security Review se recoupent.

Configurer Security Review

Pour obtenir des instructions de configuration et des options plus détaillées, consultez Security Review.

  1. Connectez votre dépôt GitHub à Codex.
  2. Accédez aux paramètres de Codex.
  3. Choisissez votre dépôt. Sous Examiner les vulnérabilités de sécurité, activez Revue de sécurité automatique et choisissez les auteurs dont les pull requests seront examinées avec Revue. Réglez Déclencheur sur À chaque exécution de la revue de code pour l’exécuter en parallèle de la revue de code.

Demander une Security Review

Pour demander manuellement une Security Review, ajoutez ce commentaire à une pull request :

@codex security review

Codex réagit pendant l’exécution de la revue, puis publie les constats de sécurité directement sur la pull request. Ouvrez la tâche Codex associée et sélectionnez l’onglet Rapport de sécurité pour afficher le rapport complet.

Traiter les constats de la revue

Une fois que Codex a publié une revue, vous pouvez lui demander de corriger les problèmes dans la même pull request en laissant un autre commentaire :

@codex fix the P1 issue

Codex démarre une conversation cloud dans l’ancienne version avec la pull request comme contexte et peut pousser un correctif sur la branche lorsqu’il dispose de l’autorisation nécessaire.

Confier d’autres tâches à Codex

Si vous mentionnez @codex dans un commentaire avec autre chose que review, Codex démarre une conversation cloud dans l’ancienne version en utilisant votre pull request comme contexte.

@codex fix the CI failures

Résoudre les problèmes de revue de code

Si Codex ne réagit pas ou ne publie pas de revue :

  • Vérifiez que vous avez activé la revue de code pour le dépôt dans les paramètres de Codex.
  • Vérifiez que la pull request appartient à un dépôt GitHub connecté à Codex.
  • Utilisez exactement le déclencheur @codex review dans un commentaire de pull request.
  • Pour les revues automatiques, vérifiez Revue automatique dans les paramètres du dépôt et Préférences personnelles dans les paramètres de Codex. Vérifiez que l’événement de la pull request correspond aux paramètres de déclenchement de vos revues.