rcywongaa/test_cicd

Test CI/CD

This repo aims to experiment with CI/CD for improved development efficiency

CI

GitHub Actions

See .github/workflows/build_and_test.yml

CircleCI

See .circleci/config.yml

Static Code Analyzer

CppCheck

clang-tidy

• http://clang.llvm.org/extra/clang-tidy/ Currently all bugprone- checks are run

No styles are checked at the moment

• http://clang.llvm.org/docs/ClangFormatStyleOptions.html
• https://clang.llvm.org/extra/clang-tidy/checks/readability-identifier-naming.html

iwyu

lwyu

Doxygen

Document files are generated in the package's docs directory (e.g. my_lib/docs)

Issues

Doxygen and CMake are project / package local, meaning there's no way to create a single doxygen file that contains all packages within this repo.

• https://vicrucann.github.io/tutorials/quick-cmake-doxygen/

References

• https://ortogonal.github.io/cmake-clang-tidy/
• https://blog.kitware.com/static-checks-with-cmake-cdash-iwyu-clang-tidy-lwyu-cpplint-and-cppcheck/
• https://github.com/TheLartians/ModernCppStarter
• https://github.com/filipdutescu/modern-cpp-template
• https://github.blog/2016-08-17-simpler-github-pages-publishing/
• https://github.com/StableCoder/cmake-scripts