cpp linter action

c/c ++リンジターアクション_{^{| Clang-Format＆Clang-Tidy}}

Clang-TidyとClang-formatを統合するC/C ++コードを覆うためのGitHubアクションは、 file-annotations 、 thread-comments 、ワークフローstep-summary 、プルリクエストレビューの形で提供されるフィードバックを収集します（ tidy-reviewまたはformat-reviewを使用）。

警告

DebianベースのLinux OS（Ubuntuなど）を使用してLinuxランナーのみをサポートしています。

MacOSとWindowsランナーもサポートされています。

使用法

注記

ワークフローがコンテナでジョブを実行している場合は、Python 3.10をDocker画像にインストールする必要があります（＃185の説明を参照）。私たちの意図は、Ubuntuの最新のLTSリリースに含まれるデフォルトのPythonバージョンと同期することです。

プロジェクトで新しい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の使用：

Clang-Format Annotations

質問やフィードバックがありますか？

フィードバックを提供するには（機能を要求したり、バグを報告したりします）、問題に投稿してください。

ライセンス

このプロジェクトのスクリプトとドキュメントは、MITライセンスの下でリリースされます