PR-Agent 실습

윈도우에서 PR-Agent 테스트 방법

1. 로컬 설치 및 설정

1. 저장소 클론하기:

   git clone https://github.com/group-3-sPRinter/pr-agent.git
   cd pr-agent

2. 가상 환경 생성 및 활성화 (선택 사항이지만 권장):

   python -m venv venv
   venv\Scripts\activate

3. 의존성 설치:

   pip install -e .
   # 또는
   pip install -r requirements.txt

4. 시크릿 설정 파일 만들기:

   copy pr_agent\settings\.secrets_template.toml pr_agent\settings\.secrets.toml

5. 시크릿 설정 파일에 API 키 추가:
   .secrets.toml 파일을 메모장이나 다른 텍스트 편집기로 열어 편집합니다:

   [openai]
   key = "your-openai-api-key"
   
   [github]
   user_token = "your-github-personal-access-token"

   • OpenAI API 키는 여기에서 얻을 수 있습니다.
   • GitHub 토큰은 여기에서 얻을 수 있으며, 토큰에는 repo 권한이 필요합니다.

2. 테스트 방법

방법 1: 기존 PR에서 테스트

1. 기존 PR 선택: 이미 존재하는 PR의 URL을 선택합니다.

2. CLI로 describe 명령 실행:

   python -m pr_agent.cli --pr_url=https://github.com/group-3-sPRinter/pr-agent/pull/123 describe

   실제 PR 번호로 123을 대체하세요.

방법 2: 새 PR 만들고 테스트

1. 새 브랜치 만들기:

   git checkout -b test-pr-agent

2. 변경 사항 추가: 파일을 수정하고 커밋합니다.

   echo # Test change >> README.md
   git add README.md
   git commit -m "Test PR-Agent describe functionality"

3. 브랜치 푸시 및 PR 생성:

   git push origin test-pr-agent

   그리고 GitHub에서 PR을 생성합니다.

4. describe 명령 실행:

   python -m pr_agent.cli --pr_url=<새로 생성한 PR의 URL> describe

방법 3: Docker를 사용하여 테스트 (Docker Desktop 설치 필요)

1. Docker Desktop 설치: Docker Desktop 다운로드

2. Docker 명령 실행:

   docker run --rm -it -e OPENAI.KEY=<your-openai-api-key> -e GITHUB.USER_TOKEN=<your-github-token> codiumai/pr-agent:latest --pr_url=<PR-URL> describe

3. 로컬 출력만 확인하기

처음에는 PR을 직접 수정하지 않고 로컬에서만 출력을 확인하는 것이 좋습니다. 이를 위해 설정 파일을 수정하거나 명령줄 옵션을 사용할 수 있습니다:

python -m pr_agent.cli --pr_url=<PR-URL> describe --config.publish_output=false

4. 설정 변경 테스트

다양한 설정으로 테스트하려면 다음과 같이 명령에 매개변수를 추가할 수 있습니다:

python -m pr_agent.cli --pr_url=<PR-URL> describe --pr_description.generate_ai_title=true --pr_description.publish_labels=true

로그

결과물