ai pr reviewer
1.16.2
이것은 CodeRabbit의 이전 버전이며 현재 유지 관리 모드에 있습니다. CodeRabbit에서 Pro 버전을 설치하는 것이 좋습니다. Pro 버전은 완전히 재설계되었으며 사용량을 통해 학습하고 시간이 지남에 따라 개선되는 훨씬 더 나은 리뷰를 제공합니다. CodeRabbit Pro는 오픈 소스 프로젝트에 대해 무료입니다.
CodeRabbit ai-pr-reviewer OpenAI의 gpt-3.5-turbo 및 gpt-4 모델을 사용하는 GitHub 풀 요청에 대한 AI 기반 코드 검토자 및 요약자입니다. GitHub Action으로 사용하도록 설계되었으며 모든 풀 요청에서 실행되고 댓글을 검토하도록 구성할 수 있습니다.
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 와 같은 필수 환경 변수를 구성해야 합니다. 사용법, 예제, 기여, FAQ에 대한 자세한 내용은 아래 섹션을 참조하세요.
ai-pr-reviewer GitHub Action으로 실행됩니다. .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 Action 환경에서 이미 사용 가능해야 합니다. 이는 풀 요청에 주석을 추가하는 데 사용됩니다.OPENAI_API_KEY : OpenAI API로 인증하는 데 사용합니다. 여기에서 하나를 얻을 수 있습니다. GitHub Action 비밀에 이 키를 추가하세요.OPENAI_API_ORG : (선택 사항) OpenAI API가 여러 개인 경우 지정된 조직을 사용하려면 이를 사용합니다. GitHub Action 비밀에 이 키를 추가하세요.gpt-4 및 gpt-3.5-turbo 변경 사항 요약( 구성의 openai_light_model )과 같은 가벼운 작업에는 gpt-3.5-turbo 사용하고 보다 복잡한 검토 및 주석 작업(구성의 openai_heavy_model )에는 gpt-4 사용하는 것이 좋습니다.
비용: gpt-3.5-turbo 는 엄청나게 저렴합니다. gpt-4 는 훨씬 더 비싸지만 결과는 훨씬 더 우수합니다. 우리는 일반적으로 gpt-4 기반 검토 및 댓글을 사용하는 20명의 개발자 팀에 하루 20달러를 지출하고 있습니다.
참조: 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을 무시할 수 있습니다. PR을 무시하려면 PR 설명에 다음 키워드를 추가하세요.
@coderabbitai: ignore
ai-pr-reviewer가 작성한 리뷰 중 일부
프롬프트 개선을 위한 제안이나 끌어오기 요청을 높이 평가합니다.
먼저, 노드 17 이상으로 테스트된 합리적으로 현대적인
node버전이 있어야 합니다.
종속성 설치
$ npm installTypescript를 빌드하고 배포용으로 패키지화
$ npm run build && npm run package GitHub Actions는 포크된 저장소의 비밀에 대한 액세스를 제한합니다. 이 기능을 활성화하려면 워크플로 파일에서 pull_request 대신 pull_request_target 이벤트를 사용해야 합니다. 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 설정합니다. 그러면 메시지가 표시됩니다.
