cit

CIT-控制它

使用此連續集成模板控制您的C ++代碼。

CIT-是用於開發C ++代碼庫的項目模板。它在單個，準備使用模板中匯總了襯裡，靜態和動態分析工具。

項目的主要目標

• 探索自動工具的功能及其對開發的影響

• 使項目統一訪問林格和分析工具的用戶

• 展示測試代碼庫不同屬性的技術

• 通過Docker和Nix提供可再現的構建和環境

• 鼓勵負責制定優質軟件的態度

特徵

• 該存儲庫通過Docker和Nix提供了可再現的開發和測試環境。

• 支持主要C ++編譯器，並啟用了所有編譯時間檢查

• 熟悉的跨平台構建設置使用CMAKE和CONAN

• 與醫生和消毒劑一起運行時間測試

• 簡化功能使用的命令行工具

  

• 由於與Megalinter的修補版集成，許多襯裡，格式化和靜態分析工具都集成和設置為項目的各個方面，並提供信息豐富的報告

  

• 您無需盯著原始工具日誌，多虧了CodeChecker，您可以查看摘要表，項目統計信息和瀏覽器中的報告

• 即使您不能在本地運行它 - 這也不是問題。準備使用GitHub CI設置，並使用相同的支票和報告上傳為文物

• 如果Linters發現了一些問題，拉的請求將不會通過

  

• 評論Dog評論CPP Linters在拉的請求中輸出

  

• Linters建議和自動修復程序也由ReviewDog顯示為拉的建議。

  

• 拉動請求以覆蓋結果為註釋：示例。當PR沒有問題時，您將看到Bot的更新消息

  

• 用拉請求Codecov報告的代碼覆蓋範圍

  

• 所有帶有日誌的文物都可以從CI下載

當前狀態

該項目正在開發中，預計API，設置和工具的變化。它對項目使用有思想的規則和約定，隨時更改配置文件以最適合您的個人需求。您可以分叉並進行遊戲，歡迎對源代碼，問題和請求的貢獻。

入門

您可以在與用戶環境的不同級別集成中使用此模板。從使用文本編輯器並在CI中運行所有檢查，到使用準備好的Docker Image或Nix-Shell並在本地運行檢查。

1. 分叉此項目，啟用GitHub操作並使用Gi​​tHub編輯器或本地文本編輯器進行編輯

2. 項目使用CMAKE NINJA和CONAN。如果您在系統上安裝了它們，則可以像其他任何CMAKE項目一樣構建和運行測試。或從項目的根來運行此BASH腳本以使用GCC構建項目：

      ci/builders/gcc/build.sh

3. 要在本地使用此項目以全部潛在的潛力：

• 安裝Docker比您可以使用準備好的Docker映像。從項目的根來調用此腳本以在Docker Image內部運行Bash Shell

     ci/docker/run_shell.sh

• 安裝NIX軟件包管理器或使用Nixos。在這種情況下，請致電Nix-shell

     nix-shell

用法

好的。您可以使用Docker Image或Nix-Shell獲得環境​​，讓我們看看下一步是什麼。為了簡化項目的使用，我們僅使用。因此我們可以這樣稱呼：

   just

您將看到可用的食譜（操作），可以使用項目：

讓我們探索主要功能。您可以使用命令使用GCC或Clang編譯器構建項目：

   just build-gcc

   just build-clang

在您的項目上運行所有Linters使用：

   just lint-all

要在項目上運行特定的Linter，請使用lint-with命令，名稱為描述符和linter的所有資本案例所有資本案例由下劃線分配。因此

   just lint-with CPP_CLANG_TIDY

我們將看到單個林格的報告：

覆蓋後，您可以使用Linter的所有日誌檢查報告文件夾。

從Nix-Shell或Docker圖像中，您還可以自己構建Docker圖像。尼克斯用來可重複地用包含所有襯裡的docker圖像構建焦油檔案

   just docker-build

您可以檢查產生的結果與CI產生的結果相同。

   sha256sum result

docker映像比結果從結果上加載：

   just docker-load

或者，您可以局部運行docker-update，以進行圖像創建，sha256sum並在單個命令中加載：

   just docker-update-locally

Docker-Update命令將構建圖像並將其上傳到Docker-Hub：

   just docker-update

要查看所有內部工作，請在JustFile中查看每個動作的混凝土bash腳本。檢查github工作流程中的github ci設置。

可用工具

• 在線服務

  • GitHub操作 - 檢查/構建/運行測試
  • 編解碼器 - 驗證測試的代碼覆蓋範圍
  • LGTM-構建和分析源代碼
  • DIDENDABOT-檢查依賴項

• 統一控制台命令

  • 只是-CC0 1.0通用

• git

  • GIT -GPLV2，LGPLV2.1
  • git -sizer-麻省理工學院
  • 符合-MPL2.0
  • commitlint-麻省理工學院
  • Gitlint-麻省理工學院
  • git -lint -apache 2.0
  • gitleaks-麻省理工學院

• 許可證

  • 重複使用-Apache -2.0

• 文件和目錄

  • LS -lint-麻省理工學院

• 拼寫

  • CSPELL-麻省理工學院
  • codespell -gplv.2.0

• CPP靜態分析

  • clang-警告作為錯誤檢查-Apache 2.0
  • clang -format -NCSA
  • clang -tidy -ncsa
  • CPPCHECK -GPLV3.0
  • CPPLINT -BSD 3句
  • GCC-警告作為錯誤檢查-GPLV3.0

• CPP動態分析

  • clang-消毒劑-Apache 2.0
  • GCC-消毒劑-GPLV3.0
  • GRCOV-代碼覆蓋 - MPL -2.0

• CPP庫用法的示例

  • 醫生 - 麻省理工學院
  • 結果-Apache -2.0

• cmake

  • CMAKE-FORMAT GPLV3.0
  • CMake-lint GPLV3.0

• 殼

  • ShellCheck -GPLV3.0

• 尼克斯

  • nixpkgs-fmt-apache-2.0
  • NIX-LINTER-BSD 3-sause
  • Nix-Shell-LGPL-2.1許可證

• MD文件

  • 備註 - 麻省理工學院
  • Textlint-麻省理工學院

• yaml

  • Yamllint -GPLV3.0

計劃

• CPP工具

  • JSCPD-麻省理工學院
  • Valgrind -GPLV2.0
  • libfuzzer -NCSA
  • doxygen -gplv2.0
  • Standardese -MIT
  • Mull -Apache -2.0
  • mutate_cpp-麻省理工學院
  • Rapidcheck-BSD-2-C-sause
  • Clazy -LGPLV2
  • 推斷 - 麻省理工學院
  • PVS Studio

• CPP編譯器

  • MSVC -Microsoft Eula
  • mingw -gnu gpl

• CI環境

  • macos
  • 視窗

• 圖書館用法的示例

  • QT6
  • OPENSSL -APACHE -2.0
  • GSL -Lite -MIT

• GUI測試

  • Sikulix1-麻省理工學院

• 可再現的構建測試

  • SHA256SUM -GPL -3.0

• 統一控制台命令

  • 沙啞 - 麻省理工學院

• 批准測試

  • applovaltests.cpp -Apache -2.0

• 微生物標準測試

• 編譯時間基準測試

• Wiki關於項目

• 徽標和插圖

• 穩定的發布版本和標籤

• 路線圖

學分

非常感謝貢獻者。您可以在學分中看到貢獻者。

執照

CIT模板按照MIT許可條款發布。有關更多信息，請參見許可證。