ai pr reviewer
1.16.2
Это старая версия CodeRabbit, которая сейчас находится в режиме обслуживания. Мы рекомендуем установить версию Pro с CodeRabbit. Версия Pro представляет собой полностью измененный дизайн и предлагает значительно лучшие отзывы, которые учитываются на основе вашего использования и улучшаются с течением времени. CodeRabbit Pro бесплатен для проектов с открытым исходным кодом.
CodeRabbit ai-pr-reviewer — это средство проверки кода и суммирования на основе искусственного интеллекта для запросов на извлечение GitHub с использованием моделей OpenAI gpt-3.5-turbo и gpt-4 . Он предназначен для использования в качестве действия GitHub и может быть настроен для запуска при каждом запросе на включение и просмотре комментариев.
gpt-3.5-turbo ) и «тяжелой» моделью обзора (например, gpt-4 ). Для достижения наилучших результатов используйте gpt-4 в качестве «тяжелой» модели, поскольку тщательный анализ кода требует сильных способностей к рассуждению.review_simple_changes и review_comment_lgtm значение true .system_message , summarize и summarize_release_notes чтобы сосредоточиться на конкретных аспектах процесса проверки или даже изменить цель проверки. Чтобы использовать этот инструмент, вам необходимо добавить предоставленный файл YAML в свой репозиторий и настроить необходимые переменные среды, такие как GITHUB_TOKEN и OPENAI_API_KEY . Для получения дополнительной информации об использовании, примерах, вкладе и часто задаваемых вопросах вы можете обратиться к разделам ниже.
ai-pr-reviewer запускается как действие GitHub. Добавьте приведенный ниже файл в свой репозиторий по адресу .github/workflows/ai-pr-reviewer.yml
name : Code Review
permissions :
contents : read
pull-requests : write
on :
pull_request :
pull_request_review_comment :
types : [created]
concurrency :
group :
${{ github.repository }}-${{ github.event.number || github.head_ref ||
github.sha }}-${{ github.workflow }}-${{ github.event_name ==
' pull_request_review_comment ' && 'pr_comment' || 'pr' }}
cancel-in-progress : ${{ github.event_name != 'pull_request_review_comment' }}
jobs :
review :
runs-on : ubuntu-latest
steps :
- uses : coderabbitai/ai-pr-reviewer@latest
env :
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY : ${{ secrets.OPENAI_API_KEY }}
with :
debug : false
review_simple_changes : false
review_comment_lgtm : false GITHUB_TOKEN : он уже должен быть доступен в среде действий GitHub. Это используется для добавления комментариев к запросу на включение.OPENAI_API_KEY : используйте это для аутентификации с помощью OpenAI API. Вы можете получить его здесь. Добавьте этот ключ в свои секреты действий GitHub.OPENAI_API_ORG : (необязательно) используйте это, чтобы использовать указанную организацию с OpenAI API, если у вас их несколько. Добавьте этот ключ в свои секреты действий GitHub.gpt-4 и gpt-3.5-turbo Рекомендуется использовать gpt-3.5-turbo для более простых задач, таких как обобщение изменений ( openai_light_model в конфигурации) и gpt-4 для более сложных задач просмотра и комментирования ( openai_heavy_model в конфигурации).
Стоимость: gpt-3.5-turbo стоит очень дешево. gpt-4 на порядки дороже, но результаты значительно превосходят. Обычно мы тратим 20 долларов в день на команду разработчиков из 20 человек, которые проводят обзоры и комментарии на основе gpt-4 .
См.: action.yml.
Совет. Вы можете изменить личность бота, настроив значение system_message . Например, для просмотра документов/сообщений в блоге вы можете использовать следующую подсказку:
system_message : |
You are `@coderabbitai` (aka `github-actions[bot]`), a language model
trained by OpenAI. Your purpose is to act as a highly experienced
DevRel (developer relations) professional with focus on cloud-native
infrastructure.
Company context -
CodeRabbit is an AI-powered Code reviewer.It boosts code quality and cuts manual effort. Offers context-aware, line-by-line feedback, highlights critical changes,
enables bot interaction, and lets you commit suggestions directly from GitHub.
When reviewing or generating content focus on key areas such as -
- Accuracy
- Relevance
- Clarity
- Technical depth
- Call-to-action
- SEO optimization
- Brand consistency
- Grammar and prose
- Typos
- Hyperlink suggestions
- Graphics or images (suggest Dall-E image prompts if needed)
- Empathy
- Engagement Вы можете ответить на комментарий к обзору, сделанный этим действием, и получить ответ на основе контекста сравнения. Кроме того, вы можете пригласить бота в беседу, отметив его в комментарии ( @coderabbitai ).
Пример:
@coderabbitai Пожалуйста, создайте план тестирования для этого файла.
Примечание. Комментарий к обзору — это комментарий, сделанный к различиям или файлам в запросе на включение.
Иногда полезно игнорировать пиар. Например, если вы используете это действие для просмотра документации, вы можете игнорировать запросы на запрос, которые только меняют документацию. Чтобы игнорировать PR, добавьте в описание PR следующее ключевое слово:
@coderabbitai: ignore
Некоторые обзоры, сделанные ai-pr-reviewer
Любые предложения или запросы на улучшение подсказок приветствуются.
Во-первых, вам понадобится достаточно современная версия
node, протестированная на узле 17+.
Установите зависимости
$ npm installСоздайте машинописный текст и упакуйте его для распространения.
$ npm run build && npm run package GitHub Actions ограничивает доступ к секретам из разветвленных репозиториев. Чтобы включить эту функцию, вам необходимо использовать событие pull_request_target вместо pull_request в файле рабочего процесса. Обратите внимание, что при использовании pull_request_target вам потребуется дополнительная настройка, чтобы обеспечить проверку правильного коммита:
name : Code Review
permissions :
contents : read
pull-requests : write
on :
pull_request_target :
types : [opened, synchronize, reopened]
pull_request_review_comment :
types : [created]
concurrency :
group :
${{ github.repository }}-${{ github.event.number || github.head_ref ||
github.sha }}-${{ github.workflow }}-${{ github.event_name ==
' pull_request_review_comment ' && 'pr_comment' || 'pr' }}
cancel-in-progress : ${{ github.event_name != 'pull_request_review_comment' }}
jobs :
review :
runs-on : ubuntu-latest
steps :
- uses : coderabbitai/ai-pr-reviewer@latest
env :
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY : ${{ secrets.OPENAI_API_KEY }}
with :
debug : false
review_simple_changes : false
review_comment_lgtm : falseСм. также: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
Установите debug: true в файле рабочего процесса, чтобы включить режим отладки, в котором будут отображаться сообщения.
