AutoReviewer

? Examens de code automatisés alimentés par ChatGPT ?

Une action GitHub utilise GPT-4 d'OpenAI pour effectuer des révisions de code automatisées. Lorsque vous créez un PR, notre action examinera automatiquement le code et suggérera des modifications, tout comme le ferait un réviseur de code humain.

Comment l'utiliser

• Obtenez une clé API d'OpenAI
• Ajoutez-le comme secret GitHub
• Configurer une action qui s'exécute à chaque PR

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
jobs :
  code-review :
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

• Ou lorsqu'une étiquette est ajoutée

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
    types : [labeled]
jobs :
  code-review :
    if : ${{ contains( github.event.label.name, 'AutoReview') }}
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

Paramètres d'entrée

Paramètre	Requis	Défaut	Description
github_token	Vrai		Nécessaire pour communiquer avec GitHub. Généré automatiquement par le GHA
openai_api_key	Vrai		Clé API OpenAI
nom_modèle	FAUX	gpt-3.5-turbo	Modèle de chat OpenAI. Prend actuellement en charge gpt-4 et gpt-3.5-turbo
modèle_température	FAUX	0	Température du modèle OpenAI
exclure_fichiers	FAUX		Fournissez une expression générique pour exclure les fichiers de la révision du code. Par exemple, *.md exclura tous les fichiers Markdown. Plusieurs expressions sont prises en charge via des virgules, par exemple *.js, *.cjs

? Avantages

Utiliser notre action GitHub présente de nombreux avantages, tels que :

• Révisions de code plus rapides
• Des commentaires plus cohérents
• Productivité accrue
• Qualité du code améliorée

? Limites

• Cette action GitHub en est encore aux premiers stades de développement.
• Bien que l'action prenne en charge à la fois gpt-4 et gpt-3.5-turbo , gpt-4 donne de bien meilleures suggestions.

? Contribuer

Si vous avez des idées ou des améliorations à apporter à notre action GitHub, n'hésitez pas à soumettre un PR. Nous apprécions toutes les contributions !