AutoReviewer

? ¿Revisiones de código automatizadas impulsadas por ChatGPT?

Una acción de GitHub utiliza GPT-4 de OpenAI para realizar revisiones de código automatizadas. Cuando crea un PR, nuestra acción revisará automáticamente el código y sugerirá cambios, tal como lo haría un revisor de código humano.

como usarlo

• Obtenga una clave API de OpenAI
• Agréguelo como un secreto de GitHub
• Configurar una acción que se ejecute en cada 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. 

• O cuando se agrega una etiqueta

 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. 

Parámetros de entrada

Parámetro	Requerido	Por defecto	Descripción
token_github	Verdadero		Necesario para comunicarse con GitHub. Autogenerado por la GHA
openai_api_key	Verdadero		Clave API de OpenAI
nombre_modelo	FALSO	gpt-3.5-turbo	Modelo de chat OpenAI. Actualmente soporta gpt-4 y gpt-3.5-turbo
temperatura_modelo	FALSO	0	Temperatura del modelo OpenAI
excluir_archivos	FALSO		Proporcione una expresión comodín para excluir archivos de la revisión del código. Por ejemplo, *.md excluirá todos los archivos Markdown. Se admiten varias expresiones mediante comas, por ejemplo *.js, *.cjs

? Beneficios

Usar nuestra acción GitHub tiene muchos beneficios, tales como:

• Revisiones de código más rápidas
• Comentarios más consistentes
• Mayor productividad
• Calidad de código mejorada

? Limitaciones

• Esta acción de GitHub aún se encuentra en desarrollo inicial.
• Si bien la acción admite tanto gpt-4 como gpt-3.5-turbo , gpt-4 ofrece sugerencias mucho mejores.

? Contribuyendo

Si tiene alguna idea o mejora para nuestra acción de GitHub, no dude en enviar un PR. ¡Agradecemos todas las contribuciones!