ai pr reviewer
1.16.2
นี่คือ CodeRabbit เวอร์ชันเก่า และตอนนี้อยู่ในโหมดบำรุงรักษา เราขอแนะนำให้ติดตั้งเวอร์ชัน Pro จาก CodeRabbit เวอร์ชัน Pro เป็นการออกแบบใหม่ทั้งหมดและเสนอบทวิจารณ์ที่ดีขึ้นอย่างเห็นได้ชัด ซึ่งเรียนรู้จากการใช้งานของคุณและปรับปรุงอยู่ตลอดเวลา CodeRabbit Pro เป็นบริการฟรีสำหรับโครงการโอเพ่นซอร์ส
CodeRabbit ai-pr-reviewer คือผู้ตรวจสอบโค้ดและตัวสรุปโค้ดที่ใช้ AI สำหรับคำขอดึง GitHub โดยใช้โมเดล gpt-3.5-turbo และ gpt-4 ของ OpenAI ได้รับการออกแบบมาเพื่อใช้เป็น GitHub Action และสามารถกำหนดค่าให้รันทุกคำขอดึงและตรวจสอบความคิดเห็นได้
gpt-3.5-turbo ) และโมเดลรีวิว "หนัก" (เช่น gpt-4 ) เพื่อให้ได้ผลลัพธ์ที่ดีที่สุด ให้ใช้ gpt-4 เป็นรูปแบบ "หนักมาก" เนื่องจากการตรวจสอบโค้ดอย่างละเอียดจำเป็นต้องมีความสามารถในการให้เหตุผลสูงreview_simple_changes และ review_comment_lgtm เป็น truesystem_message , summarize และ summarize_release_notes เพื่อเน้นไปที่แง่มุมเฉพาะของกระบวนการตรวจสอบ หรือแม้แต่เปลี่ยนวัตถุประสงค์ของการรีวิว หากต้องการใช้เครื่องมือนี้ คุณต้องเพิ่มไฟล์ YAML ที่ให้มาลงในที่เก็บของคุณและกำหนดค่าตัวแปรสภาพแวดล้อมที่จำเป็น เช่น GITHUB_TOKEN และ OPENAI_API_KEY สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการใช้งาน ตัวอย่าง การมีส่วนร่วม และคำถามที่พบบ่อย คุณสามารถดูได้จากส่วนด้านล่าง
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 แนะนำให้ใช้ gpt-3.5-turbo สำหรับงานเบา เช่น การสรุปการเปลี่ยนแปลง ( openai_light_model ในการกำหนดค่า) และ gpt-4 สำหรับงานตรวจสอบและแสดงความคิดเห็นที่ซับซ้อนมากขึ้น ( openai_heavy_model ในการกำหนดค่า)
ราคา: gpt-3.5-turbo นั้นราคาถูกมาก gpt-4 นั้นมีราคาแพงกว่ามาก แต่ผลลัพธ์ก็เหนือกว่าอย่างมาก โดยทั่วไปเราจะใช้จ่าย $20 ต่อวันสำหรับทีมนักพัฒนาซอฟต์แวร์ 20 ทีมพร้อมการตรวจสอบและแสดงความคิดเห็นตาม gpt-4
ดูที่: 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
ข้อเสนอแนะหรือคำขอใด ๆ เพื่อปรับปรุงคำแนะนำจะได้รับการชื่นชมอย่างมาก
ขั้นแรก คุณจะต้องมี
nodeเวอร์ชันที่ทันสมัยพอสมควร ซึ่งทดสอบกับโหนด 17+ แล้ว
ติดตั้งการพึ่งพา
$ npm installสร้าง typescript และจัดทำแพ็กเกจเพื่อจำหน่าย
$ npm run build && npm run package GitHub Actions จำกัดการเข้าถึงข้อมูลลับจากที่เก็บข้อมูลแบบแยกส่วน หากต้องการเปิดใช้งานคุณลักษณะนี้ คุณต้องใช้เหตุการณ์ pull_request_target แทน pull_request ในไฟล์เวิร์กโฟลว์ของคุณ โปรดทราบว่าด้วย 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 ในไฟล์เวิร์กโฟลว์เพื่อเปิดใช้งานโหมดแก้ไขข้อบกพร่อง ซึ่งจะแสดงข้อความ
