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许可条款发布。有关更多信息，请参见许可证。