run-gemini-cli

개요

run-gemini-cli는 [Gemini CLI]를 통해 [Gemini]를 개발 워크플로우에 통합하는 GitHub Action입니다. 이는 중요한 일상적인 코딩 작업을 위한 자율 에이전트이자, 작업을 빠르게 위임할 수 있는 주문형 협력자 역할을 합니다.

GitHub 저장소 내에서 [Gemini]와 대화형으로(예: @gemini-cli 이 이슈 수정) GitHub Pull Request 리뷰 수행, 이슈 분류, 코드 분석 및 수정 등을 수행하는 데 사용합니다.

• run-gemini-cli
  • 개요
  • 기능
  • 빠른 시작
    • 1. Gemini API 키 받기
    • 2. GitHub Secret으로 추가
    • 3. .gitignore 업데이트
    • 4. 워크플로우 선택
    • 5. 사용해 보세요!
  • 워크플로우
    • Gemini Dispatch
    • Issue Triage
    • Pull Request Review
    • Gemini CLI Assistant
  • 구성
    • 입력값
    • 출력값
    • 저장소 변수
    • 시크릿
  • 인증
    • Google 인증
    • GitHub 인증
  • 관측 가능성
  • 확장 기능
  • 모범 사례
  • 커스터마이징
  • 기여

기능

• 자동화: 이벤트(예: 이슈 열림) 또는 일정(예: 야간)에 따라 워크플로우 트리거.
• 주문형 협업: 이슈 및 Pull Request 댓글에서 [Gemini CLI]를 멘션하여 워크플로우 트리거 (예: @gemini-cli /review).
• 도구를 통한 확장 가능: [Gemini] 모델의 도구 호출 기능을 활용하여 [GitHub CLI] (gh)와 같은 다른 CLI와 상호 작용.
• 커스터마이징 가능: 저장소에 GEMINI.md 파일을 사용하여 [Gemini CLI]에 프로젝트별 지침 및 컨텍스트 제공.

빠른 시작

몇 분 만에 저장소에서 Gemini CLI를 시작하세요:

1. Gemini API 키 받기

[Google AI Studio]에서 API 키를 받으세요. 관대한 무료 할당량이 제공됩니다.

2. GitHub Secret으로 추가

API 키를 GEMINI_API_KEY라는 이름의 시크릿으로 저장소에 저장하세요:

• 저장소의 Settings > Secrets and variables > Actions로 이동
• New repository secret 클릭
• Name: GEMINI_API_KEY, Value: API 키 입력

3. .gitignore 업데이트

.gitignore 파일에 다음 항목을 추가하세요:

# gemini-cli 설정
.gemini/

# GitHub App 자격 증명
gha-creds-*.json

4. 워크플로우 선택

워크플로우 설정에는 두 가지 옵션이 있습니다:

옵션 A: setup 명령 사용 (권장)

1. 터미널에서 Gemini CLI 시작:

   gemini
   

2. 터미널의 Gemini CLI에서 다음 입력:

   /setup-github
   

옵션 B: 수동으로 워크플로우 복사

1. examples/workflows 디렉토리에서 사전 빌드된 워크플로우를 저장소의 .github/workflows 디렉토리로 복사합니다. 참고: gemini-dispatch.yml 워크플로우도 복사해야 워크플로우가 실행되도록 트리거됩니다.

5. 사용해 보세요!

Pull Request 리뷰:

• 저장소에서 Pull Request를 열고 자동 리뷰를 기다립니다.
• 기존 Pull Request에 @gemini-cli /review 댓글을 달아 수동으로 리뷰를 트리거합니다.

Issue Triage (이슈 분류):

• 이슈를 열고 자동 분류를 기다립니다.
• 기존 이슈에 @gemini-cli /triage 댓글을 달아 수동으로 분류를 트리거합니다.

일반 AI 지원:

• 모든 이슈 또는 Pull Request에서 @gemini-cli 뒤에 요청을 멘션합니다.
• 예시:
  • @gemini-cli 이 코드 변경 설명해줘
  • @gemini-cli 이 함수에 대한 개선 제안
  • @gemini-cli 이 오류 디버깅 도와줘
  • @gemini-cli 이 컴포넌트에 대한 단위 테스트 작성해줘

워크플로우

이 액션은 다양한 사용 사례를 위한 여러 사전 빌드된 워크플로우를 제공합니다. 각 워크플로우는 저장소의 .github/workflows 디렉토리에 복사하여 필요에 따라 커스터마이징할 수 있습니다.

Gemini Dispatch

이 워크플로우는 Gemini CLI의 중앙 디스패처 역할을 하며, 트리거 이벤트와 댓글에 제공된 명령에 따라 적절한 워크플로우로 요청을 라우팅합니다. 디스패치 워크플로우 설정에 대한 자세한 가이드는 Gemini Dispatch 워크플로우 문서를 참조하세요.

Issue Triage

이 액션은 GitHub Issues를 자동으로 또는 일정에 따라 분류하는 데 사용할 수 있습니다. 이슈 분류 시스템 설정에 대한 자세한 가이드는 GitHub Issue Triage 워크플로우 문서를 참조하세요.

Pull Request Review

이 액션은 Pull Request가 열릴 때 자동으로 리뷰하는 데 사용할 수 있습니다. Pull Request 리뷰 시스템 설정에 대한 자세한 가이드는 GitHub PR Review 워크플로우 문서를 참조하세요.

Gemini CLI Assistant

이러한 유형의 액션은 Pull Request 및 이슈 내에서 범용 대화형 Gemini AI 어시스턴트를 호출하여 다양한 작업을 수행하는 데 사용할 수 있습니다. 일반 목적 Gemini CLI 워크플로우 설정에 대한 자세한 가이드는 Gemini Assistant 워크플로우 문서를 참조하세요.

구성

입력값

• gcp_location: (선택 사항) Google Cloud 위치.

• gcp_project_id: (선택 사항) Google Cloud 프로젝트 ID.

• gcp_service_account: (선택 사항) Google Cloud 서비스 계정 이메일.

• gcp_workload_identity_provider: (선택 사항) Google Cloud Workload Identity Provider.

• gcp_token_format: (선택 사항, 기본값: access_token) 인증을 위한 토큰 형식. "access_token"으로 설정하면 액세스 토큰을 생성합니다(서비스 계정 필요). 빈 문자열로 설정하면 직접 WIF를 사용합니다. "access_token" 또는 "id_token"이 될 수 있습니다.

• gcp_access_token_scopes: (선택 사항, 기본값: https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/userinfo.profile) token_format이 "access_token"인 경우의 액세스 토큰 범위. 쉼표로 구분된 OAuth 2.0 범위 목록.

• gemini_api_key: (선택 사항) Gemini API용 API 키.

• gemini_cli_version: (선택 사항, 기본값: latest) 설치할 Gemini CLI 버전. "latest", "preview", "nightly", 특정 버전 번호, 또는 git 브랜치, 태그, 커밋이 될 수 있습니다. 자세한 내용은 Gemini CLI 릴리스를 참조하세요.

• gemini_debug: (선택 사항) 디버그 로깅 및 출력 스트리밍을 활성화합니다.

• gemini_model: (선택 사항) Gemini와 함께 사용할 모델.

• google_api_key: (선택 사항) Gemini와 함께 사용할 Vertex AI API 키.

• prompt: (선택 사항, 기본값: You are a helpful assistant.) Gemini CLI의 --prompt 인수에 전달되는 문자열입니다.

• settings: (선택 사항) CLI의 프로젝트 설정을 구성하기 위해 .gemini/settings.json에 기록되는 JSON 문자열입니다. 자세한 내용은 설정 파일 문서를 참조하세요.

• use_gemini_code_assist: (선택 사항, 기본값: false) 기본 Gemini API 키 대신 Gemini 모델 액세스에 Code Assist를 사용할지 여부. 자세한 내용은 Gemini CLI 문서를 참조하세요.

• use_vertex_ai: (선택 사항, 기본값: false) 기본 Gemini API 키 대신 Gemini 모델 액세스에 Vertex AI를 사용할지 여부. 자세한 내용은 Gemini CLI 문서를 참조하세요.

• extensions: (선택 사항) 설치할 Gemini CLI 확장 기능 목록.

• upload_artifacts: (선택 사항, 기본값: false) GitHub Action에 아티팩트를 업로드할지 여부.