Eine GitHub-Aktion zum Linken von C/C ++-Code, die Klang-Tidy und Klangformat integrieren, um Feedback zu sammeln, die in Form von file-annotations , thread-comments , Workflow step-summary und Zuganforderungenbewertungen (mit tidy-review oder format-review ) bereitgestellt werden.
Warnung
Wir unterstützen nur Linux-Läufer mit einem Debian-basierten Linux-Betriebssystem (wie Ubuntu und vielen anderen).
MacOS und Windows -Läufer werden ebenfalls unterstützt.
Notiz
Python 3.10 muss im Docker -Bild installiert werden, wenn Ihr Workflow Jobs in einem Container ausführt (siehe Diskussion in #185). Unsere Absicht ist es, mit der Standard -Python -Version zu synchronisieren, die in den neuesten LTS -Veröffentlichungen von Ubuntu enthalten ist.
Erstellen Sie einen neuen Workflow für GitHub-Aktionen in Ihrem Projekt, z.
Der Inhalt der Datei sollte im folgenden Format liegen.
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 1Alle Erläuterungen unserer verfügbaren Eingabeparameter und Ausgangsvariablen finden Sie in unserem Dokument für Eingänge und Ausgänge.
Siehe auch unsere Beispielrezepte.
Verwenden von file-annotations :
Um Feedback zu geben (Anfordern einer Funktion oder Berichterstattung über einen Fehler), veröffentlichen Sie bitte auf Probleme.
Die Skripte und die Dokumentation in diesem Projekt werden unter der MIT -Lizenz veröffentlicht