Tindakan GitHub untuk linting C/C ++ Code yang mengintegrasikan klang-ridy dan format dentang untuk mengumpulkan umpan balik yang disediakan dalam bentuk file-annotations , thread-comments , step-summary alur kerja, dan ulasan permintaan tarik (dengan tidy-review atau format-review ).
Peringatan
Kami hanya mendukung pelari Linux menggunakan OS Linux yang berbasis di Debian (seperti Ubuntu dan banyak lainnya).
MacOS dan Windows Runners juga didukung.
Catatan
Python 3.10 perlu diinstal pada gambar Docker jika alur kerja Anda menjalankan pekerjaan dalam wadah (lihat diskusi di #185). Tujuan kami adalah untuk menyinkronkan dengan versi Python default yang disertakan dengan rilis LTS terbaru Ubuntu.
Buat alur kerja tindakan github baru dalam proyek Anda, misalnya di .github/workflows/cpp-linter.yml
Konten file harus dalam format berikut.
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 1Untuk semua penjelasan dari parameter input dan variabel output kami yang tersedia, lihat dokumen input dan output kami.
Lihat juga resep contoh kami.
Menggunakan file-annotations :
Untuk memberikan umpan balik (meminta fitur atau melaporkan bug) silakan memposting ke masalah.
Skrip dan dokumentasi dalam proyek ini dirilis di bawah lisensi MIT