cit

CIT-コントロールします

この連続統合テンプレートを使用して、C ++コードを制御します。

CIT-は、C ++コードベースの開発のためのプロジェクトテンプレートです。 Linter、静的および動的な分析ツールを単一の使用、使用可能なテンプレートで集約します。

プロジェクトの主な目標

• 自動ツールの機能と開発への影響を探る

• プロジェクトの統一アクセスのユーザーに、リナーと分析ツールへのアクセスを提供します

• コードベースのさまざまな特性をテストするショーケース手法

• Dockerとnixを通じて、再現可能なビルドと環境を提供します

• 高品質のソフトウェアの開発に対する責任ある態度を奨励します

特徴

• このリポジトリは、 DockerとNixのおかげでバージョンのピン留めの再現可能な開発とテスト環境を提供します

• 主要なC ++コンパイラのサポート、すべてのコンパイル時間チェックが有効になっています

• CmakeとConanを使用した馴染みのあるクロスプラットフォームビルドセットアップ

• DoctestおよびSanitizersによるランタイムテスト

• 機能の使用を簡素化するためのコマンドラインツール

  

• Megalinterのパッチバージョンとの統合のおかげで、プロジェクトの各側面に統合およびセットアップされたプロジェクトの各側面に統合およびセットアップされた多くのリナー、フォーマッタ、および静的分析ツール

  

• Toolsの生ログを見つめる必要はありません。CodeCheckerのおかげで、概要表、プロジェクトの統計、ブラウザのレポートを確認できます。

• 地元で実行できなくても、それは問題ではありません。同じチェックとレポートを使用してGitHub CIセットアップを使用する準備ができていますArtifactsとしてアップロードされたレポート

• Lintersがいくつかの問題を見つけた場合、Pullリクエストは渡されません

  

• ReviewDogのコメントCPPリンジター出力は、プルリクエストで出力されます

  

• リナーの提案と自動修正は、ReviewDogによってプルリクエストの提案として表示されます

  

• コメント：例として、糸くずの結果を使用してフィードバックをリクエストします。 PRに問題が残っていない場合は、ボットから更新されたメッセージが表示されます

  

• プルリクエストCodecovレポートを使用したコードカバレッジ

  

• ログ付きのすべてのアーティファクトは、CIからダウンロードできます

現在のステータス

このプロジェクトは開発中であり、API、セットアップ、ツールの変更が予想されます。それは、プロジェクトに意見のある一連のルールと慣習を使用しています。個人的なニーズに最適な構成ファイルを自由に変更してください。フォークしてプレイできます。ソースコードへの貢献、問題、リクエストは大歓迎です。

はじめる

このテンプレートは、ユーザー環境とのさまざまなレベルの統合で使用できます。テキストエディターの使用とCIですべてのチェックを実行してから、準備されたDockerイメージまたはNix-Shellの使用、およびローカルでチェックを実行するまで。

1. このプロジェクトをフォークし、githubアクションを有効にし、githubエディターまたはローカルテキストエディターで編集します

2. プロジェクトでは、Cmake NinjaとConanを使用します。システムにインストールしている場合は、他のCMAKEプロジェクトと同様にテストを構築および実行できます。または、プロジェクトのrootからこのbashスクリプトを実行して、GCCを使用してプロジェクトを構築します。

      ci/builders/gcc/build.sh

3. このプロジェクトをローカルに使用するには、オプションがあります。

• 準備されたDocker画像を使用できるよりもDockerをインストールします。プロジェクトのルートからこのスクリプトを呼び出して、docker画像内でバッシュシェルを実行します

     ci/docker/run_shell.sh

• NIXパッケージマネージャーをインストールするか、Nixosを使用します。その場合、Nix-Shellを呼び出します

     nix-shell

使用法

わかった。 DockerイメージまたはNix-Shellで環境を手に入れました。次のことを見てみましょう。プロジェクトの使用を容易にするために使用します。だから私たちはそれをそのように呼ぶことができます：

   just

プロジェクトを使用するためにできる利用可能なレシピ（アクション）が表示されます。

主な機能を探りましょう。コマンドを使用して、GCCまたはClangコンパイラでプロジェクトを構築できます。

   just build-gcc

   just build-clang

プロジェクトですべてのリンターを実行するには：

   just lint-all

プロジェクトで特定のリナーを実行するには、記述子とリナーの名前を持つLint-Withコマンドを使用して、すべてのキャピタルケースがアンダースコアによって分割されます。したがって、CPP記述子からClang-Tidyを実行したい場合は、次のように呼び出します。

   just lint-with CPP_CLANG_TIDY

そして、シングルリナーのレポートをご覧ください：

糸くずの後、Linterのすべてのログを使用してレポートフォルダーを確認できます。

Nix-ShellまたはDocker画像から、Dockerイメージを自分で作成することもできます。 Nixは、すべてのリナーを含むDocker画像でTARアーカイブを再現できるように構築するために使用されます

   just docker-build

生成された結果がCIによって生成された結果と同じハッシュ合計を持っていることを確認できます。

   sha256sum result

結果からロードされるよりもDocker画像：

   just docker-load

または、docker-update-locallyを実行して、画像作成、sha256sum、および単一コマンドでロードすることもできます。

   just docker-update-locally

docker-updateコマンドは画像を作成し、Docker-Hubにアップロードします。

   just docker-update

すべての内部の仕組みを見るには、各アクションの具体的なバッシュスクリプトをJustFileをご覧ください。 GitHub CIのセットアップについては、GitHubワークフローファイルを確認してください。

利用可能なツール

• オンラインサービス

  • GitHubアクション - テストをチェック/ビルド/実行します
  • Codecov-テストのコードカバレッジを確認します
  • LGTM-ソースコードを構築および分析します
  • DependAbot-依存関係を確認します

• 統一されたコンソールコマンド

  • Just -CC0 1.0ユニバーサル

• git

  • git -gplv2、lgplv2.1
  • Git -Sizer -MIT
  • 適合-MPL2.0
  • commitlint -mit
  • gitlint -mit
  • git -lint -apache 2.0
  • GitLeaks -MIT

• ライセンス

  • 再利用-pache -2.0

• ファイルとディレクトリ

  • LS -LINT -MIT

• スペル

  • cspell -mit
  • CodeSpell -GPLV.2.0

• CPP静的分析

  • Clang-エラーチェックとしての警告-Apache2.0
  • Clang -format -ncsa
  • Clang -Tidy -NCSA
  • cppcheck -gplv3.0
  • cpplint -bsd 3節
  • GCC-エラーチェックとしての警告-GPLV3.0

• CPP動的分析

  • Clang-消毒剤-Apache2.0
  • GCC-消毒剤-GPLV3.0
  • GRCOV-コードカバレッジ-MPL -2.0

• CPPライブラリの使用例

  • Doctest -MIT
  • 結果-Apache -2.0

• cmake

  • cmake-format gplv3.0
  • cmake-lint gplv3.0

• シェル

  • シェルチェック-GPLV3.0

• nix

  • nixpkgs-fmt-apache-2.0
  • nix-linter-BSD 3節
  • nix-shell-LGPL-2.1ライセンス

• MDファイル

  • 注：mit
  • textlint -mit

• Yaml

  • yamllint -gplv3.0

計画

• CPPツール

  • JSCPD -MIT
  • Valgrind -GPLV2.0
  • Libfuzzer -NCSA
  • doxygen -gplv2.0
  • Standardese -MIT
  • マル-Apache -2.0
  • mutate_cpp -mit
  • RapidCheck-BSD-2-Clause
  • clazy -lgplv2
  • 推測-MIT
  • PVSスタジオ

• CPPコンパイラ

  • MSVC -Microsoft Eula
  • Mingw -Gnu gpl

• CI環境

  • macos
  • Windows

• ライブラリの使用例

  • QT6
  • OpenSSL -Apache -2.0
  • GSL -Lite -MIT

• GUIテスト

  • Sikulix1 -MIT

• 再現可能なビルドテスト

  • SHA256SUM -GPL -3.0

• 統一されたコンソールコマンド

  • ハスキー - mit

• 承認テスト

  • 承認tests.cpp -apache -2.0

• マイクロベンチマーク

• タイムベンチマークをコンパイルします

• プロジェクトについてのウィキ

• ロゴとイラスト

• 安定したリリースバージョンとタグ

• ロードマップ

クレジット

貢献者に感謝します。クレジットで貢献者を見ることができます。

ライセンス

MITライセンスの条件に基づいてリリースされたCITテンプレート。詳細については、ライセンスを参照してください。