การกระทำของ GitHub สำหรับการตัดแต่งรหัส C/C ++ ที่รวมการรวมตัวกันของ clang-tidy และ clang-format เพื่อรวบรวมข้อเสนอแนะที่มีให้ในรูปแบบของ file-annotations , thread-comments , เวิร์กโฟลว์ step-summary tidy-review และ format-review การร้องขอ
คำเตือน
เรารองรับนักวิ่ง Linux โดยใช้ Linux OS ที่ใช้ Debian (เช่น Ubuntu และอื่น ๆ อีกมากมาย)
รองรับนักวิ่ง MacOS และ Windows เช่นกัน
บันทึก
Python 3.10 ต้องติดตั้งในอิมเมจนักเทียบท่าหากเวิร์กโฟลว์ของคุณกำลังทำงานในคอนเทนเนอร์ (ดูการสนทนาใน #185) ความตั้งใจของเราคือการซิงโครไนซ์กับรุ่น Python เริ่มต้นที่มาพร้อมกับ LTS รุ่นล่าสุดของ Ubuntu
สร้างเวิร์กโฟลว์การกระทำของ GitHub ใหม่ในโครงการของคุณเช่นที่ .github/Workflows/CPP-linter.yml
เนื้อหาของไฟล์ควรอยู่ในรูปแบบต่อไปนี้
steps :
- uses : actions/checkout@v4
- uses : cpp-linter/cpp-linter-action@v2
id : linter
env :
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
with :
style : ' file ' # Use .clang-format config file
tidy-checks : ' ' # Use .clang-tidy config file
# only 'update' a single comment in a pull request thread.
thread-comments : ${{ github.event_name == 'pull_request' && 'update' }}
- name : Fail fast?!
if : steps.linter.outputs.checks-failed > 0
run : exit 1สำหรับคำอธิบายทั้งหมดของพารามิเตอร์อินพุตที่มีอยู่ของเราและตัวแปรเอาต์พุตดูเอกสารอินพุตและเอาต์พุตของเรา
ดูเพิ่มเติมตัวอย่างสูตรของเรา
การใช้ file-annotations :
เพื่อให้ข้อเสนอแนะ (การขอคุณสมบัติหรือการรายงานข้อบกพร่อง) โปรดโพสต์ไปยังปัญหา
สคริปต์และเอกสารในโครงการนี้ได้รับการเผยแพร่ภายใต้ใบอนุญาต MIT