PR Agent＠エージェンティックコーディング¶
はじめに¶
本サイトにつきまして、以下をご認識のほど宜しくお願いいたします。
01. セットアップ¶
GitLab¶
workflow:
rules:
- if: $CI_COMMIT_TAG
- if: $CI_COMMIT_BRANCH
# もしworkflowのルールを設定している場合、merge_request_eventをルールの条件としないと、ワークフローが起動しない
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
stages:
- build
- test
- pr_agent
pr_agent:
stage: pr_agent
image:
name: pr-agent:latest
entrypoint: [""]
variables:
# Cross-region-inferenceに対応するためにusを指定する
# 対応不要の場合はap-northeast-1でもよい
AWS_REGION_NAME: "us-east-1"
before_script:
# もしAWS Bedlockを使用する場合は、資格情報を取得する
script:
- cd /app
- echo "Running PR Agent action step"
- export MR_URL="$CI_MERGE_REQUEST_PROJECT_URL/merge_requests/$CI_MERGE_REQUEST_IID"
- echo "MR_URL=$MR_URL"
- export gitlab__url=$CI_SERVER_PROTOCOL://$CI_SERVER_FQDN
- export gitlab__PERSONAL_ACCESS_TOKEN=$GITLAB_PERSONAL_ACCESS_TOKEN
- export config__git_provider="gitlab"
- python -m pr_agent.cli --pr_url="$MR_URL" describe
- python -m pr_agent.cli --pr_url="$MR_URL" review
- python -m pr_agent.cli --pr_url="$MR_URL" improve
allow_failure: true
rules:
# merge_request_eventの時にJobを発火させないと、PR AgentはMRの情報を取得できずにエラーになってしまう
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
02. Webhook¶
Webhookを使用したCI発火¶
PR上で/<コマンド>を実行することで、Webhookを介してPR-Agentを実行できる。
プッシュのたびにPR-Agentを実行させるとレビューへの修正負荷が高いため、PR-Agentの発火はWebhookで制御した方が良い。
/describe¶
変更内容から、自動的にMRの種別や変更内容などをdescriptionに記載する。
/review¶
変更したコードの問題点やセキュリティ的な脆弱性などをレビューし、PRにコメントする。
/improve¶
コードの改善点をMRにコメントする。
/ask <質問内容>¶
PR全体や特定の行について質問する。
/config¶
現在のpr-agentの設定を出力する。
/help¶
pr-agentの使い方を出力する。
03. configセクション¶
model¶
メインで使用するmodelを設定する。
[config]
model="bedrock/us.anthropic.claude-3-7-sonnet-20250219-v1:0"
fallback_models¶
処理に失敗した際のfallbackで使用するmodelを設定する。
[config]
fallback_models=["bedrock/anthropic.claude-3-haiku-20240307-v1:0"]
response_language¶
言語を設定する。
[config]
response_language="ja-JP"
verbosity_level¶
大きい値を設定するとより詳細にログ出力する。
[config]
# 0,1,2
verbosity_level=0
log_level¶
[config]
log_level="INFO"
use¶
Webhook側ではなく本リポジトリ側の設定を優先する。
[config]
use_repo_settings_file=true
use_global_settings_file=false
use_wiki_settings_file=false
04 github_appセクション¶
handle_push_trigger¶
プッシュでPR-Agentが起動するフラグを設定する。
[github_app]
handle_push_trigger=false
05. pr_descriptionセクション¶
enable_help¶
Helpセクションを設定する。
[pr_description]
enable_help_comment = false
enable_help_text=false
enable_pr_diagram¶
Diagramセクションを設定する。
[pr_description]
enable_pr_diagram=true
enable_pr_type¶
PR Typeセクションを設定する。
[pr_description]
enable_pr_type=false
inline_file_summary、collapsible_file_list、enable_semantic_files_types¶
Changes walkthroughセクションを設定する。
[pr_description]
inline_file_summary=false
collapsible_file_list=false
enable_semantic_files_types=false
enable_help¶
Helpセクションを設定する。
[pr_description]
enable_help_comment = false
enable_help_text=false
extra_instructions¶
PRの説明欄に関するプロンプトを設定する。
[pr_description]
extra_instructions="""\
- impactレベルは「high」または「medium」のみを使用すること。「low」のimpactレベルを提案することは禁止である。
"""
06. pr_reviewerセクション¶
enable_help_text¶
Helpセクション設定する。
[pr_reviewer]
enable_help_text=false
extra_instructions¶
PRレビューに関するプロンプトを設定する。
[pr_reviewer]
extra_instructions="""\
- impactレベルは「high」または「medium」のみを使用すること。「low」のimpactレベルを提案することは禁止である。
"""
require_score_review¶
PRスコア算出のフラグを設定する。
[pr_reviewer]
require_score_review=true
07. pr_code_suggestionsセクション¶
extra_instructions¶
コード提案に関するプロンプトを設定する。
[pr_code_suggestions]
extra_instructions="""\
- impactレベルは「high」または「medium」のみを使用すること。「low」のimpactレベルを提案することは禁止である。
"""
persistent_comment¶
レビューのたびに新しいコメントを追加するフラグを設定する
[pr_code_suggestions]
persistent_comment=false