Une action GitHub pour libellir le code C / C ++ intégrant Clang-Tidy et Clang-Format pour collecter les commentaires fournis sous forme d' file-annotations , thread-comments , step-summary et d'évaluation de la demande de workflow et de révocations de la demande (avec tidy-review ou format-review ).
Avertissement
Nous prenons uniquement des coureurs Linux en utilisant un Linux OS basé à Debian (comme Ubuntu et bien d'autres).
Les macOS et les coureurs Windows sont également pris en charge.
Note
Python 3.10 doit être installé dans l'image Docker si votre flux de travail exécute des travaux dans un conteneur (voir la discussion dans # 185). Notre intention est de se synchroniser avec la version Python par défaut incluse avec les dernières versions LTS d'Ubuntu.
Créez un nouveau workflow GitHub Actions dans votre projet, par exemple chez .github / workflows / cpp-Linter.yml
Le contenu du fichier doit être dans le format suivant.
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 1Pour toutes les explications de nos paramètres d'entrée et variables de sortie disponibles, consultez notre document d'entrées et de sorties.
Voir aussi nos exemples de recettes.
Utilisation file-annotations :
Pour fournir des commentaires (demander une fonctionnalité ou signaler un bogue), veuillez publier sur les problèmes.
Les scripts et la documentation de ce projet sont publiés sous la licence MIT