
เรียกใช้เวิร์กโฟลว์ AI ที่ขับเคลื่อนด้วย codebase ของคุณ
- บทสรุปการใช้ชีวิตของรหัสของคุณใน readmes ที่ซ้อนกัน
Todos ติดตามปัญหา
⏳รักษาประวัติของการโทร API ใน Git
- สรุปการเปลี่ยนแปลงโดยการเพิ่มฉลาก "สรุป" ลงใน PR
- การกระทำที่กำหนดเองกำหนดค่าใน yaml
โปรดดูคู่มือการติดตั้ง
แม้ว่าจะใช้ภายใน แต่โครงการนี้ยังไม่ได้รับการดูแลอย่างแข็งขัน
จนถึง v0.1.2, คำขอดึงอัตโนมัติที่สร้างขึ้นอัตโนมัติจากปัญหา หากคุณยังคงต้องการใช้ AutoPr สำหรับสิ่งนี้ให้ตั้งค่าบรรทัดต่อไปนี้ในการดำเนินการ gitHub ของคุณ yaml:
uses : docker://ghcr.io/irgolic/autopr:v0.1.2ด้านล่างเป็นตัวอย่างของการใช้ชีวิตของ Autop
โฟลเดอร์นี้มีไฟล์และโฟลเดอร์ต่าง ๆ ที่เกี่ยวข้องกับงานอัตโนมัติและเวิร์กโฟลว์ มันรวมถึง DockerFile สำหรับการตั้งค่าอิมเมจนักเทียบท่าไฟล์ใบอนุญาตที่ระบุข้อกำหนดการใช้งาน makefile สำหรับงานการพัฒนาอัตโนมัติไฟล์การกำหนดค่าการกระทำสำหรับเวิร์กโฟลว์การร้องขอการดึง, เชลล์สคริปต์สำหรับการดำเนินการกำหนดค่าการล็อคและการกำหนดค่า ไฟล์และโฟลเดอร์เหล่านี้ให้ฟังก์ชั่นสำหรับงานอัตโนมัติการจัดการการกระทำและการดำเนินการ GIT และดำเนินการเวิร์กโฟลว์ที่ปรับแต่งได้
Dockerfile ตั้งค่าอิมเมจนักเทียบท่าตาม duffn/python-poetry:3.9-bullseye image
- ติดตั้ง Git จากที่เก็บ Bullseye-Backports
- คัดลอกสคริปต์ entrypoint และทำให้สามารถดำเนินการได้
- คัดลอกไฟล์ pyproject.toml และ poetry.lock
- เปิดใช้งานสภาพแวดล้อมเสมือนจริงและติดตั้งการพึ่งพาโครงการโดยใช้บทกวี
- คัดลอกส่วนที่เหลือของไฟล์ไปยังไดเรกทอรี /app
- ติดตั้งแอปพลิเคชันโดยใช้บทกวี
ตั้งค่า entrypoint เป็น /entrypoint.sh สำหรับเรียกใช้แอป
LICENSE.md - ไฟล์นี้มีใบอนุญาต MIT
ใบอนุญาตอนุญาตให้ใช้แก้ไขและแจกจ่ายซอฟต์แวร์
ใบอนุญาตต้องมีประกาศลิขสิทธิ์และการแจ้งเตือนการอนุญาตให้รวมอยู่ในสำเนาทั้งหมด
ซอฟต์แวร์มีให้ "ตามสภาพ" โดยไม่มีการรับประกัน
- ใบอนุญาตนั้นใช้ได้จนถึงปี 2566
ใบอนุญาตเป็นเจ้าของโดย Raphael Francis Ltd
Makefile ไฟล์นี้เป็นไฟล์กำหนดค่าที่คล้าย MakeFile
- มันกำหนดเป้าหมายต่าง ๆ และคำสั่งที่เกี่ยวข้อง
เป้าหมายคือ: format type test schema และ all
- เป้าหมาย format ใช้คำสั่งเพื่อจัดรูปแบบรหัสโดยใช้เครื่องมือ black
- type เป้าหมายเรียกใช้คำสั่งเพื่อทำการตรวจสอบประเภทโดยใช้ pyright
- เป้าหมาย test ทำงาน pytest บนไดเรกทอรี autopr/tests
- เป้าหมาย schema เรียกใช้คำสั่งเพื่อสร้างจุดเข้าร่วมการกำหนดค่าโดยใช้ autopr.models.config
- เป้าหมาย all เรียกใช้เป้าหมายทั้งหมดตามลำดับ: format type test และ schema
- ไฟล์นี้มีวัตถุประสงค์เพื่อทำให้งานการพัฒนาทั่วไปเป็นไปโดยอัตโนมัติและให้แน่ใจว่าคุณภาพของรหัส
action.yml - ไฟล์นี้เป็นไฟล์กำหนดค่าสำหรับเวิร์กโฟลว์การร้องขอการดึงอัตโนมัติ
- มันระบุรายละเอียดสำหรับการรันเวิร์กโฟลว์เช่นอิมเมจนักเทียบท่าที่จะใช้
- นอกจากนี้ยังรวมถึงข้อมูลการสร้างแบรนด์เช่นไอคอนและสีที่ใช้
- ไฟล์กำหนดอินพุตที่จำเป็นสำหรับเวิร์กโฟลว์เช่นโทเค็น GitHub และสาขาฐาน
- มันมี URL GIF โหลดเริ่มต้นที่จะแสดงในขณะที่มีการสร้างคำขอดึง
- ไฟล์กำหนดเทมเพลตสำหรับชื่อของสาขาเป้าหมาย
มันระบุว่าจะเขียนทับสาขาที่มีอยู่และดึงคำขอเมื่อสร้างจากปัญหา
autopr/โฟลเดอร์นี้มีคอลเลกชันของไฟล์ Python และโฟลเดอร์ที่เกี่ยวข้องกับงานอัตโนมัติและเวิร์กโฟลว์ มันมีไฟล์สำหรับการกระทำและยูทิลิตี้จุดเริ่มต้นสำหรับการกระทำของ GitHub, การกำหนดค่าการบันทึก, บริการหลักสำหรับการเรียกใช้ทริกเกอร์และเวิร์กโฟลว์, โมเดลสำหรับการสร้างและดำเนินการเวิร์กโฟลว์, บริการสำหรับการจัดการการกระทำและการดำเนินการ GIT, การกำหนดค่าทริกเกอร์และสคริปต์และไฟล์การกำหนดค่าสำหรับการจัดการเวิร์กโฟลว์ ไฟล์และโฟลเดอร์เหล่านี้ให้ฟังก์ชั่นสำหรับงานอัตโนมัติโต้ตอบกับแพลตฟอร์ม GitHub และดำเนินการเวิร์กโฟลว์ที่ปรับแต่งได้
entrypoint.sh ไฟล์เป็นเชลล์สคริปต์
- มันตั้งค่าการกำหนดค่า GIT สำหรับไดเรกทอรีเฉพาะ
✉ตั้งค่าอีเมลผู้ใช้และชื่อสำหรับ Git Commits
- มันเปิดใช้งานสภาพแวดล้อมเสมือนจริง
- มันรันโมดูล Python ที่เรียกว่า autopr.gh_actions_entrypoint
poetry.lock - ไฟล์นี้เป็นบทสรุปผู้บริหารของโครงการหรือรายงาน
- ให้ภาพรวมระดับสูงของประเด็นหลัก
มันเน้นการค้นพบที่สำคัญข้อสรุปและคำแนะนำ
อาจรวมถึงข้อมูลสรุปของข้อมูลหรือการวิเคราะห์
มีไว้สำหรับคนที่ยังใหม่กับโครงการหรือรายงาน
ไม่รวมถึงรายละเอียดเล็กน้อยหรือคำอธิบายทางเทคนิค
มันให้ความเข้าใจที่ชัดเจนเกี่ยวกับวัตถุประสงค์และขอบเขตของโครงการ
- มันให้ภาพรวมอย่างรวดเร็วเกี่ยวกับเนื้อหาโดยไม่ต้องลึกซึ้ง
มันทำหน้าที่เป็นจุดเริ่มต้นสำหรับการสำรวจหรือการอภิปรายเพิ่มเติม
- มันกระชับและอ่านง่ายแม้ว่าไฟล์จะว่างเปล่า
pyproject.toml - ไฟล์นี้เป็นไฟล์กำหนดค่าสำหรับโครงการ Python โดยใช้บทกวี
- มันมีข้อมูลเกี่ยวกับชื่อรุ่นและผู้แต่งของโครงการ
- ใบอนุญาตของโครงการถูกระบุเป็น MIT
- มันแสดงรายการแพ็คเกจและการอ้างอิงที่จำเป็นสำหรับโครงการ
- มีการพึ่งพาแยกต่างหากสำหรับการทดสอบและการพัฒนา
- ระบบสร้างที่ใช้คือบทกวี
- ไฟล์ยังรวมถึงการกำหนดค่าสำหรับตัวตรวจสอบประเภท Pyright Static
- มันระบุความยาวบรรทัดและรุ่นเป้าหมายสำหรับตัวฟอร์แมตรหัสสีดำ
strict_workflow_schema.json - ไฟล์เป็นสคีมา JSON ที่อธิบายถึงคำจำกัดความของเวิร์กโฟลว์ที่เข้มงวด
- มันกำหนดการกระทำต่าง ๆ ที่สามารถทำได้ภายในเวิร์กโฟลว์
- การกระทำรวมถึงการแสดงความคิดเห็นการตั้งค่าชื่อปัญหาไฟล์เดินการโทร API การเรียกใช้คำสั่ง BASH และอื่น ๆ
การกระทำแต่ละครั้งมีชุดอินพุตและเอาต์พุตของตัวเอง
ขั้นตอนเวิร์กโฟลว์ถูกกำหนดให้เป็นอาร์เรย์ของการกระทำ
สคีมายังรวมถึงคำจำกัดความสำหรับประเภทข้อมูลและการประกาศที่ใช้ภายในการกระทำ
วัตถุประสงค์ของไฟล์คือการจัดเตรียมโครงสร้างที่เป็นมาตรฐานสำหรับการกำหนดและดำเนินการเวิร์กโฟลว์ที่เข้มงวด
สคีมาสามารถใช้เพื่อตรวจสอบและตรวจสอบความถูกต้องของคำจำกัดความของเวิร์กโฟลว์
- ช่วยให้สามารถรวมเข้ากับเครื่องมือและระบบอื่น ๆ ที่รองรับสคีมาได้อย่างง่ายดาย
ไฟล์สามารถใช้เป็นข้อมูลอ้างอิงสำหรับการทำความเข้าใจโครงสร้างและความสามารถของเวิร์กโฟลว์ที่เข้มงวด
trigger_schema.json - ไฟล์นี้เป็นเอกสาร JSON ที่อธิบายการกำหนดค่าทริกเกอร์สำหรับเวิร์กโฟลว์
- มันกำหนดประเภททริกเกอร์ต่าง ๆ เช่นฉลากความคิดเห็นการผลักและทริกเกอร์ cron
? ️แต่ละประเภททริกเกอร์มีชุดคุณสมบัติของตัวเองและสามารถปรับแต่งได้
- ทริกเกอร์สามารถใช้เพื่อเริ่มต้นการกระทำหรือเวิร์กโฟลว์เฉพาะตามเหตุการณ์บางอย่าง
เอกสารยังรวมถึงคำจำกัดความสำหรับโมเดลการกระทำที่แตกต่างกันและคุณสมบัติของพวกเขา
- แบบจำลองการกระทำเหล่านี้สามารถใช้ภายในทริกเกอร์เพื่อระบุพฤติกรรมที่ต้องการ
ไฟล์ให้ภาพรวมที่ครอบคลุมของทริกเกอร์และโมเดลแอ็คชั่นที่มีอยู่
- สามารถใช้เป็นคู่มืออ้างอิงสำหรับการกำหนดค่าและปรับแต่งเวิร์กโฟลว์
โครงสร้างไฟล์ถูกจัดระเบียบโดยใช้วัตถุและคุณสมบัติที่ซ้อนกัน
- สิ่งสำคัญคือต้องทบทวนทริกเกอร์และคำจำกัดความการกระทำที่เฉพาะเจาะจงเพื่อทำความเข้าใจการทำงานและการใช้งานของพวกเขา
workflow_schema.json - ไฟล์นี้เป็นนิยาม JSON Schema สำหรับคำจำกัดความของเวิร์กโฟลว์
- มันกำหนดประเภทและคุณสมบัติต่าง ๆ สำหรับการกระทำที่แตกต่างกันและการประกาศที่ใช้ในเวิร์กโฟลว์
Schema รวมถึงคำจำกัดความสำหรับการกระทำเช่นการแสดงความคิดเห็นการตั้งค่าชื่อปัญหาไฟล์เดินการโทร API การเรียกใช้คำสั่ง bash ฯลฯ
นอกจากนี้ยังกำหนดประเภทของการประกาศต่าง ๆ เช่นเทมเพลตตัวแปรคงที่และการประกาศแลมบ์ดา
- คำจำกัดความของเวิร์กโฟลว์รวมถึงชื่อคำอธิบายอินพุตและเอาต์พุต
- ประกอบด้วยรายการขั้นตอนที่อาจเป็นการกระทำการเรียกใช้เวิร์กโฟลว์หรือคำสั่งตามเงื่อนไข
- ข้อความที่มีเงื่อนไขสามารถมีสาขา IF-ELSE และสนับสนุนเงื่อนไขที่แตกต่างกันเช่นนิพจน์แลมบ์ดาและการตรวจสอบบริบท
การเรียกใช้เวิร์กโฟลว์สามารถเป็นปกติหรือซ้ำได้
- โดยรวมแล้วไฟล์นี้ให้คำจำกัดความที่มีโครงสร้างสำหรับการสร้างและดำเนินการเวิร์กโฟลว์กับการกระทำและเงื่อนไขที่หลากหลาย