Intégrer les modèles de raisonnement OpenAI dans votre workflow de Pull Request (PR) GitHub peut améliorer significativement le processus de revue de code. Ce guide vous accompagnera à travers les étapes nécessaires pour configurer cette intégration, permettant des revues de code automatiques pour la qualité, la sécurité et la conformité aux standards d'entreprise.
Pourquoi intégrer les modèles de raisonnement OpenAI dans les PRs ?
- Gagner du temps : Détecter automatiquement les code smells, vulnérabilités de sécurité et incohérences de style.
- Appliquer les standards : Maintenir des standards de codage cohérents dans toute votre organisation.
- Feedback rapide : Fournir aux développeurs un feedback immédiat guidé par l'IA sur les améliorations potentielles.
Prérequis
-
Générer une clé de projet OpenAI
- Visitez platform.openai.com/api-keys pour créer une nouvelle clé secrète.
- Stockez le token de manière sécurisée dans les secrets de votre repository GitHub en tant que
OPENAI_API_KEY.
-
Choisir votre modèle OpenAI
- Sélectionnez un modèle de raisonnement OpenAI pour une analyse approfondie des modifications de code.
-
Sélectionner une Pull Request
- Assurez-vous que GitHub Actions est activé pour votre repository.
- Confirmez que vous avez les permissions pour configurer les secrets ou variables du repository.
-
Définir les standards de codage d'entreprise
- Stockez vos standards comme variable de repository (
BEST_PRACTICES).
- Stockez vos standards comme variable de repository (
-
Définir le contenu du prompt
- Construisez un méta-prompt pour guider OpenAI vers les vérifications de sécurité, qualité et bonnes pratiques.
Créer votre workflow GitHub Actions
Ce workflow GitHub Actions est déclenché à chaque pull request contre la branche main et comprend deux jobs :
-
Analyse qualité et sécurité
- Rassemble un diff de tous les fichiers modifiés et envoie ces changements à OpenAI pour analyse.
- Publie les corrections suggérées par OpenAI comme commentaire sur la PR.
-
Vérification des standards d'entreprise
- Évalue la PR par rapport à vos standards d'entreprise définis.
- Retourne un tableau markdown résumant l'adhésion du code à ces standards.
Tester le workflow
Committez ce workflow dans votre repository, puis ouvrez une nouvelle PR. Le workflow s'exécutera automatiquement, publiant le feedback généré par l'IA comme commentaire sur la PR.
Pour un exemple public, consultez le workflow du repository OpenAI-Forum.
Conclusion
En intégrant les modèles de raisonnement OpenAI dans votre workflow de PR GitHub, vous pouvez automatiser les revues de code, assurant une qualité et une sécurité de code plus élevées tout en gagnant un temps précieux.
Source : OpenAI Blog par Kevin Alwell