AI를 이용해서 Pull Request 코드 리뷰를 수행하는 간편한 GitHub Action 도구
- 간편한 설정: 단일 명령어로 워크플로우 파일 자동 생성
- 직관적인 사용법: PR 댓글에 간단한 커맨드만 입력
- 비용 효율성: 사용한 만큼만 비용 발생 (OpenAI/Gemini API)
- 다국어 지원: 원하는 언어로 리뷰 결과 제공 (기본: 한국어)
- 다양한 모델: Gemini 및 OpenAI의 여러 모델 옵션 제공
-
프로젝트 루트 경로에서 다음 명령어 실행:
bash <(curl -s https://raw.githubusercontent.com/lee-lou2/ai-code-reviewer/main/create-workflow.sh) -
GitHub 레포지토리의
Settings > Secrets and variables > Actions에서 다음 중 하나 추가:GEMINI_API_KEY: Gemini API 키OPENAI_API_KEY: OpenAI API 키
-
(선택) README.md 파일 작성(해당 내용을 참고하여 답변을 진행)
PR 생성 후 댓글에 다음과 같이 입력:
/review
특정 요구사항이 있는 경우:
/review 보안 관련 취약점을 중점적으로 검토해주세요
flowchart TD
classDef successStyle fill:#d4edda,stroke:#28a745,color:#155724
classDef errorStyle fill:#f8d7da,stroke:#dc3545,color:#721c24
classDef processStyle fill:#e2f0fb,stroke:#0275d8,color:#01579b
classDef startStyle fill:#f5f5f5,stroke:#6c757d,color:#343a40
classDef endStyle fill:#f5f5f5,stroke:#6c757d,color:#343a40
classDef reviewStyle fill:#fff3cd,stroke:#ffc107,color:#856404
A[GitHub Action 시작] --> B{PR 정보 조회}
B -->|성공| C[Readme.md 조회]
B -->|실패| D[오류 반환]
D --> E[종료]
C --> F[파일별 PR 변경 사항 확인]
subgraph 파일별_처리 [파일별 변경사항 처리]
F --> G[다음 파일]
G --> H[AI를 이용한 파일 리뷰 및 요약]
H --> I[리뷰 댓글 작성]
I --> J[요약 내용 정리]
J --> K{더 처리할 파일이 있는가?}
K -->|예| G
end
K -->|아니오| L[모든 파일 요약을 댓글로 작성]
L --> M[종료]
A:::startStyle
B:::processStyle
C:::processStyle
D:::errorStyle
E:::endStyle
G:::reviewStyle
H:::reviewStyle
I:::reviewStyle
J:::reviewStyle
K:::processStyle
L:::reviewStyle
M:::endStyle
.github/workflows/ai-code-reviewer.yml 파일에서 다음 옵션 설정 가능:
| 옵션 | 설명 | 기본값 |
|---|---|---|
GITHUB_TOKEN |
GitHub 토큰 (필수) | ${{ secrets.GITHUB_TOKEN }} |
GEMINI_API_KEY |
Gemini API 키 | - |
GEMINI_MODEL |
Gemini 모델명 | gemini-2.5-flash-preview-04-17 |
OPENAI_API_KEY |
OpenAI API 키 | - |
OPENAI_MODEL |
OpenAI 모델명 | gpt-4o-mini |
MAX_OUTPUT_TOKENS |
최대 출력 토큰 수 | 2048 |
EXCLUDE |
제외할 파일 패턴 | *.md,*.txt,package-lock.json,*.yml,*.yaml |
LANGUAGE |
리뷰 언어 | Korean |

