AutoReviewer

? Автоматизированные проверки кода на базе ChatGPT?

Действие GitHub использует GPT-4 OpenAI для выполнения автоматических проверок кода. Когда вы создаете PR, наше действие автоматически проверит код и предложит изменения, как это сделал бы человек, проверяющий код.

Как его использовать

• Получите ключ API от OpenAI
• Добавьте это как секрет GitHub.
• Настройте действие, которое запускается при каждом 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. 

• Или при добавлении ярлыка

 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. 

Входные параметры

Параметр	Необходимый	По умолчанию	Описание
github_token	Истинный		Необходимо для связи с GitHub. Автоматически сгенерировано ГСГ
openai_api_key	Истинный		API-ключ OpenAI
имя_модели	ЛОЖЬ	gpt-3.5-турбо	Модель чата OpenAI. В настоящее время поддерживает gpt-4 и gpt-3.5-turbo
модель_температура	ЛОЖЬ	0	Температура модели OpenAI
исключать_файлы	ЛОЖЬ		Укажите подстановочное выражение, чтобы исключить файлы из проверки кода. Например, *.md исключит все файлы Markdown. Несколько выражений поддерживаются через запятые, например *.js, *.cjs

? Преимущества

Использование нашего действия GitHub имеет множество преимуществ, таких как:

• Ускоренная проверка кода
• Более последовательная обратная связь
• Повышенная производительность
• Улучшено качество кода

? Ограничения

• Это действие GitHub все еще находится на ранней стадии разработки.
• Хотя действие поддерживает как gpt-4 , так и gpt-3.5-turbo , gpt-4 дает гораздо лучшие предложения.

? Содействие

Если у вас есть какие-либо идеи или улучшения нашей акции на GitHub, смело отправляйте PR. Мы приветствуем все вклады!