Fix headers destination installed by ament_auto_package by HansRobo · Pull Request #540 · ament/ament_cmake

HansRobo · 2024-07-04T08:10:02Z

To fix ros2/ros2#1150, many packages that are resigtered in rosdistro, are fixed like ament/ament_index#83.

This repository was not fixed at the time because it was not directly involved in installing header files.
However, all packages provided by this repository that use ament_auto_package to install header files have the issue reported in ros2/ros2#1150, which this PR will fix.

HansRobo · 2024-07-04T08:11:12Z

This PR needs to be backported to Humble, Iron and Jazzy.

HansRobo · 2024-07-05T07:14:25Z

I make this to draft because I found some fixes are needed.
See autowarefoundation#2 (comment)

HansRobo · 2025-04-06T02:21:42Z

OK, I finished test these changes on my repository.
https://github.com/HansRobo/ros2_sandbox/actions/runs/14287948020
HansRobo/ros2_sandbox#1

with `rolling` branch of `ament_cmake`

The header files are installed to install/include/<package name>/<header name>.hpp with merge install.
These should be installed on install/include/<package name>/ <package name> /<header name>.hpp.

https://github.com/HansRobo/ros2_sandbox/actions/runs/14287948020/job/40045385546#step:10:13

tree ./install
./install
├── COLCON_IGNORE
├── _local_setup_util_ps1.py
├── _local_setup_util_sh.py
├── include
│   ├── parent_package
│   │   └── test_node.hpp
│   └── timer_experiments
│       └── timer_statistics.hpp
...

with this pull-request

The header files are installed to install/include/<package name>/<package name>/<header name>.hpp with merge install.
These are correct install location.

https://github.com/HansRobo/ros2_sandbox/actions/runs/14287948020/job/40045385606#step:10:14

tree ./install
./install
├── COLCON_IGNORE
├── _local_setup_util_ps1.py
├── _local_setup_util_sh.py
├── include
│   ├── parent_package
│   │   └── parent_package
│   │       └── test_node.hpp
│   └── timer_experiments
│       └── timer_experiments
│           └── timer_statistics.hpp
...

without fixing `ament_export_include_directories`

a fix argument of ament_export_include_directories in ament_auto_package is added in 9adf093.
Without this, dependencies are not handled correctly.

It causes build failure on my test without the commit.
https://github.com/HansRobo/ros2_sandbox/actions/runs/14287948020/job/40045385678#step:9:59

Starting >>> child_package
--- stderr: child_package
/__w/ros2_sandbox/ros2_sandbox/ament_auto_install_test/child_package/src/child_package_node.cpp:3:10: fatal error: parent_package/test_node.hpp: No such file or directory
    3 | #include <parent_package/test_node.hpp>
      |          ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.

HansRobo · 2025-04-06T02:23:44Z

@clalancette
I finished working on this pull-request.
Could you review or assign appropriate reviewers?

sloretz

Thank you for the PR!

sloretz · 2025-04-07T16:01:49Z

@Mergifyio rebase

Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com>

mergify · 2025-04-07T16:02:02Z

rebase

✅ Branch has been successfully rebased

sloretz · 2025-04-07T16:05:27Z

Pulls: #540
Gist: https://gist.githubusercontent.com/sloretz/716fdf61cd5904d3f8821427e2c29ece/raw/27bf1cde67e8bd9d872ee6fb71a73d53f2a41f7e/ros2.repos
BUILD args: --packages-above-and-dependencies ament_cmake_auto
TEST args: --packages-above ament_cmake_auto
ROS Distro: rolling
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/15619

Linux
Linux-aarch64
Linux-rhel
Windows

HansRobo · 2025-04-07T22:14:27Z

Thank you for reviewing!

* fix headers destination installed by ament_auto_package Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com> * Fix exporting include directory target by ament_auto_package Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com> --------- Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com>

HansRobo · 2025-04-07T22:47:18Z

@sloretz
I also submitted the backport pull-requests to humble, iron, and jazzy.
Could you review them?

…ort #540) (#578) * Add USE_SCOPED_HEADER_INSTALL_DIR option to ament_auto_package Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com> * Add warning message to ament_auto_package related to USE_SCOPED_HEADER_INSTALL_DIR option Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com> * Add missing endif to ament_auto_package Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com> * Use no mode instead of WARNING in message in ament_auto_package.cmake Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com> --------- Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com>

HansRobo requested a review from clalancette as a code owner July 4, 2024 08:10

HansRobo mentioned this pull request Jul 4, 2024

fix headers destination installed by ament_auto_package autowarefoundation/ament_cmake#2

Closed

HansRobo marked this pull request as draft July 5, 2024 07:14

HansRobo marked this pull request as ready for review April 6, 2025 02:21

sloretz approved these changes Apr 7, 2025

View reviewed changes

HansRobo added 2 commits April 7, 2025 16:02

fix headers destination installed by ament_auto_package

9308307

Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com>

Fix exporting include directory target by ament_auto_package

33a6c44

Signed-off-by: Kotaro Yoshimoto <pythagora.yoshimoto@gmail.com>

sloretz force-pushed the patch-1 branch from 9adf093 to 33a6c44 Compare April 7, 2025 16:02

sloretz merged commit ed4a0a5 into ament:rolling Apr 7, 2025
3 checks passed

This was referenced Apr 7, 2025

[backport] Fix headers destination installed by ament_auto_package (#540) #574

Closed

[backport] Fix headers destination installed by ament_auto_package (#540) #575

Closed

[backport] Fix headers destination installed by ament_auto_package (#540) #576

Closed

HansRobo mentioned this pull request Apr 9, 2025

Add USE_SCOPED_HEADER_INSTALL_DIR option to ament_auto_package #577

Merged

HansRobo deleted the patch-1 branch April 18, 2025 13:50

HansRobo mentioned this pull request Apr 19, 2025

Add USE_SCOPED_HEADER_INSTALL_DIR option to ament_auto_package (backport #540) #578

Merged

HansRobo mentioned this pull request Nov 12, 2025

[WIP] fix(autoware_ament_auto_package): use scoped header install destination autowarefoundation/autoware_cmake#39

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix headers destination installed by ament_auto_package#540

Fix headers destination installed by ament_auto_package#540
sloretz merged 2 commits intoament:rollingfrom
HansRobo:patch-1

HansRobo commented Jul 4, 2024

Uh oh!

HansRobo commented Jul 4, 2024

Uh oh!

HansRobo commented Jul 5, 2024

Uh oh!

HansRobo commented Apr 6, 2025 •

edited

Loading

Uh oh!

HansRobo commented Apr 6, 2025

Uh oh!

sloretz left a comment

Uh oh!

sloretz commented Apr 7, 2025

Uh oh!

mergify bot commented Apr 7, 2025

Uh oh!

sloretz commented Apr 7, 2025

Uh oh!

Uh oh!

HansRobo commented Apr 7, 2025

Uh oh!

HansRobo commented Apr 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

HansRobo commented Jul 4, 2024

Uh oh!

HansRobo commented Jul 4, 2024

Uh oh!

HansRobo commented Jul 5, 2024

Uh oh!

HansRobo commented Apr 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

with rolling branch of ament_cmake

with this pull-request

without fixing ament_export_include_directories

Uh oh!

HansRobo commented Apr 6, 2025

Uh oh!

sloretz left a comment

Choose a reason for hiding this comment

Uh oh!

sloretz commented Apr 7, 2025

Uh oh!

mergify bot commented Apr 7, 2025

✅ Branch has been successfully rebased

Uh oh!

sloretz commented Apr 7, 2025

Uh oh!

Uh oh!

HansRobo commented Apr 7, 2025

Uh oh!

HansRobo commented Apr 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

HansRobo commented Apr 6, 2025 •

edited

Loading

with `rolling` branch of `ament_cmake`

without fixing `ament_export_include_directories`