Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 1.6 KB

README.md

File metadata and controls

25 lines (21 loc) · 1.6 KB

CI-CD-GitHub-Actions

This repository contains common GitHub Actions for use in CI/CD on FreeRTOS library repositories.

Currently, this repository contains actions for the following code quality checks that are run on FreeRTOS libraries.

  • Complexity - Uses GNU Complexity to verify that the complexity score of library functions is less than 9.
  • Formatting - Validates all C files of a FreeRTOS library repository comply to the formatting standard defined in uncrustify.cfg.
  • Doxygen - Validates that the doxygen manual of the FreeRTOS library can be built without warnings.
  • Spellings - Checks spellings across all files of the FreeRTOS library repository. Each FreeRTOS library repository should have a lexicon.txt file.
  • Coverage Cop - Enforces that the unit tests of a FreeRTOS library meet the minimum thresholds branch and line coverages. The lcov coverage output from running unit tests should be available before using this action.
  • Memory Statistics - Generates table of memory estimates for library files used in FreeRTOS library documentation. The memory estimates are generated by building the library with the ARM GCC toolchain.
  • Link Verifier - Verifies links present in source and Markdown files. Links verified include HTTP
  • Manifest.yml Verifier - Verifies that information of manifest.yml file matches the state of a repository for the presence of submodules and their commit IDs.

URLs, and - for Markdown files - relative file path links and section anchors.