CMake Boilerplate Scripts

This contains a collection of boilerplate CMake scripts and marcos.

Note: this package is not specific to ROS-Industrial and is usable with any package which uses CMake. The prefix was added to facilitate releasing this into different ROS distributions.

::: {.contents depth=”4”} Table of Contents :::

Create Debian Package (Linux) or NuGet Package (Windows)

The following process will generate a Debian or NuGet package leveraging CMake and CPack based on the OS.

The package should be located in the current directory.

` bash cd <workspace directory> catkin build -DRICB_PACKAGE=ON ./src/ros_industrial_cmake_boilerplate/.run-cpack`

Available Macros

Extract Package Metadata

This CMake macro will extract the package name and version from a package.xml file. It will create two cmake variable ${PREFIX_ARG}_extracted_name and ${PREFIX_ARG}_extracted_version.

extract_package_metadata(${PREFIX_ARG})

Clang Tidy

This CMake macro will add clang-tidy to all targets

clang_tidy(ARGUMENTS ${ARGN})
# or
clang_tidy(ARGUMENTS ${ARGN} ENABLE ${USER_ENABLE_ARG})

This CMake macro will add clang-tidy to all targets with default arguments.

clang_tidy(ARGUMENTS ${DEFAULT_CLANG_TIDY_CHECKS})
# or
clang_tidy(ARGUMENTS ${DEFAULT_CLANG_TIDY_CHECKS} ENABLE ${USER_ENABLE_ARG})

Clears clang-tidy so it is not called on any following defined code compilation. It can be re-enabled by another call to [clang_tidy()]{.title-ref}.

reset_clang_tidy()

This CMake macro will add clang-tidy to a provided target.

• The clang-tidy documentation
• The list of clang-tidy checks

::: note ::: title Note :::

Each of the macros can take an ENABLE ON/OFF so they can easily be enabled by an external flag. If not provided it is automatically enabled. :::

Single Argument Keywords:

+——————–+———-+————————————+ | Keyword | Type | Description | +====================+==========+====================================+ | ENABLE | > ON/OFF | Enable/Disable clang-tidy | +——————–+———-+————————————+ | WARNINGS_AS_ERRORS | > ON/OFF | Treat warnings as errors. If | | | | ERROR_CHECKS is not provided, it | | | | will use CHECKS to treat as | | | | errors. | +——————–+———-+————————————+ | HEADER_FILTER | > String | Default to '.*' if not | | | | provided. Regular expression | | | | matching the names of the headers | | | | to output diagnostics from. |

File truncated at 100 lines see the full file

Changelog for package ros_industrial_cmake_boilerplate

0.7.3 (2025-02-11)

• Expose ability to set clang-tidy versions
• Contributors: Levi Armstrong

0.7.2 (2025-01-21)

• Fix bug in cpack_component cmake variable naming
• Contributors: Levi Armstrong

0.7.1 (2025-01-14)

• Add script to run cpack
• Fix debian cpack pipeline (#100)
• Contributors: Levi Armstrong

0.7.0 (2025-01-11)

• Replace underscores with dashes in component names for CPack
• Contributors: Michael Ripperger

0.6.3 (2024-12-03)

• Update install_targets to leverage cmake install dir variables so they may be overriden
• Contributors: Levi Armstrong

0.6.2 (2024-07-18)

• Fix issue where executables were being added to package libraries cmake variable
• Contributors: Levi Armstrong

0.6.1 (2024-06-21)

• Add sanitizer tools (#96)
• Move individual tools to there own files
• Contributors: Levi Armstrong

0.6.0 (2024-06-10)

• Add catkin required variables _INCULDE_DIRS and _LIBRARIES
• Update package_debian.yml
• Update libraries into package_nuget.yml updated actions/checkout updated ilammy/msvc-dev-cmd
• Contributors: Levi Armstrong, mosfet80

0.5.4 (2023-09-20)

• Fixed error message when extracting maintainer information
• Contributors: Michael Ripperger

0.5.3 (2023-09-04)

• Make _supported_components capitalized in package config with components
• Make supported_components unique in package config to avoid conflict
• Contributors: Levi Armstrong

0.5.2 (2023-09-02)

• Add CPack Build Depends for creating debian source package
• Contributors: Levi Armstrong

0.5.1 (2023-09-02)

• Add check for component Unspecified and generate error if using cpack with components (#85)
• Contributors: Levi Armstrong

0.5.0 (2023-09-01)

• Add cpack create debian source package with upload support (#84)
• Add cpack metapackge
• Add cpack component support
• Add find_package component support (#82)
• Update readme to include how to exclude code from code coverage
• Contributors: Levi Armstrong

0.4.8 (2023-07-17)

• Add code coverage executable RUN_COMMAND mulit-arg to support rostest (#80)
• Contributors: Levi Armstrong

0.4.7 (2023-06-27)

• Add python hook to install_ament_hooks
• Contributors: Levi Armstrong

0.4.6 (2023-03-06)

File truncated at 100 lines see the full file