Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: apply autoware_ prefix for velodyne_monitor #9976

Merged
merged 13 commits into from
Jan 24, 2025
Merged

feat: apply autoware_ prefix for velodyne_monitor #9976

merged 13 commits into from
Jan 24, 2025

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 19, 2025 •
edited by SakodaShintaro
Loading

Description

This pull request addresses the issue of inconsistent naming by adding the autoware_ prefix to relevant components. This change ensures uniformity across the codebase and aligns with the project's naming conventions.

This has to be merged with:

Related Links

How was this PR tested?

Currently, we only verified that the build succeeds. Further checks will be performed by using the updated module. This PR will be ready for review after finishing all the necessary checks/tests.

Executed Commands (which succeeded)

$ # Around 19:00 JST 21st Jan. 2025
$ vcs import src < autoware-nighty.repos    # Commented out autoware.universe repo
$ rosdep install -y --from-paths src --ignore-src --rosdistro humble
$ colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTING=ON --packages-up-to autoware_velodyne_monitor
$ source install/setup.bash
$ ros2 launch autoware_velodyne_monitor velodyne_monitor.launch.xml

  • Directory Name

    • Add autoware_ as a prefix to the directory name.

  • packages.xml

    • Add autoware_ to the name element.

  • CMakeLists.txt

    • Change the project name to autoware_***.
    • Add autoware:: to PLUGIN.

  • Header Files (.hpp)

    • Start #ifndef guards with AUTOWARE__.
    • Add autoware:: to namespace.

  • Source Files (.cpp)

    • Add autoware:: inside RCLCPP_COMPONENTS_REGISTER_NODE.

  • Launch Files

    • Add autoware_ before find-pkg-share.
    • Change node pkg="<pkgname>" to autoware_<pkgname>.

  • Include

    • Add autoware folder as necessary and update include statements accordingly.
    • Check for impacts on other packages.

  • Verification Points

    • Search find-pkg-share in autoware
    • Check README file (especially json schema)
    • Pay attention to complex cases like sensor_launch as seen in gnss_poser

Notes for Reviewers

None.

Interface Changes

None.

Effects on System Behavior

All the developers who were using velodyne_monitor needs to modify their code. This is maybe kind of non quick-win task.

@sasakisasaki
feat(velodyne_monitor): apply autoware_ prefix (see below):
1ffe542 
  Note:
    * In this commit, I did not organize a folder structure.
      The folder structure will be organized in the next some commits.
    * The changes will follow the Autoware's guideline as below:
        - https://autowarefoundation.github.io/autoware-documentation/main/contributing/coding-guidelines/ros-nodes/directory-structure/#package-folder

Signed-off-by: Junya Sasaki <[email protected]>
@sasakisasaki
rename(velodyne_monitor): move a header under include/autoware:
71cfa49 
  * Fixes due to this changes for .hpp/.cpp files will be applied in the next commit

Signed-off-by: Junya Sasaki <[email protected]>
@sasakisasaki
fix(velodyne_monitor): fix include header path
371d658 
  * To follow the previous commit

Signed-off-by: Junya Sasaki <[email protected]>
@sasakisasaki
rename: velodyne_monitor => autoware_velodyne_monitor
f5545a4 
Signed-off-by: Junya Sasaki <[email protected]>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:system System design and integration. (auto-assigned) labels Jan 19, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 19, 2025 •
edited
Loading

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@sasakisasaki sasakisasaki marked this pull request as ready for review January 20, 2025 02:38
@sasakisasaki sasakisasaki requested a review from ito-san as a code owner January 20, 2025 02:38
@sasakisasaki sasakisasaki added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 20, 2025
@codecov Codecov
Copy link

codecov bot commented Jan 20, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 29.43%. Comparing base (5872113) to head (06f648d).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
...autoware_velodyne_monitor/src/velodyne_monitor.cpp 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #9976      +/-   ##
==========================================
- Coverage   29.74%   29.43%   -0.32%     
==========================================
  Files        1435     1426       -9     
  Lines      108308   107828     -480     
  Branches    42955    42787     -168     
==========================================
- Hits        32221    31742     -479     
- Misses      72958    73025      +67     
+ Partials     3129     3061      -68
Flag Coverage Δ *Carryforward flag
differential 0.00% <0.00%> (?)
total 29.46% <ø> (-0.28%) ⬇️ Carriedforward from fc70dc4

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sasakisasaki and others added 6 commits January 22, 2025 20:27
@sasakisasaki
Merge branch 'main' into feat-apply-autoware-prefix-for-system-velody…
e0d31ea 
…ne-monitor

Signed-off-by: Junya Sasaki <[email protected]>
@sasakisasaki
Merge branch 'feat-apply-autoware-prefix-for-system-velodyne-monitor'…
cf131c3 
… of github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-system-velodyne-monitor

Signed-off-by: Junya Sasaki <[email protected]>
@sasakisasaki
bug(velodyne_monitor): revert wrongly updated copyrights
6712954 
Signed-off-by: Junya Sasaki <[email protected]>
@sasakisasaki
bug(velodyne_monitor): fix inconsistent namespacing
7f05472 
Signed-off-by: Junya Sasaki <[email protected]>
@sasakisasaki
bug(autoware_velodyne_monitor): fix critical bugs that contaminates t…
fd47cd0 
…opic name

Signed-off-by: Junya Sasaki <[email protected]>
@mitsudome-r
docs(autoware_velodyne_monitor): update docs with the new package name
fc70dc4 
Signed-off-by: Ryohsuke Mitsudome <[email protected]>
This was referenced Jan 23, 2025
Merged
Merged
@mitsudome-r
Copy link
Member

mitsudome-r commented Jan 23, 2025 •
edited
Loading

This has to be merged with:

@mitsudome-r mitsudome-r mentioned this pull request Jan 23, 2025
Merged
ito-san
ito-san approved these changes Jan 24, 2025
View reviewed changes
Copy link
Contributor

@ito-san ito-san left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM

@mitsudome-r mitsudome-r merged commit 40aff9f into autowarefoundation:main Jan 24, 2025
33 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ito-san ito-san ito-san approved these changes

@mitsudome-r mitsudome-r mitsudome-r approved these changes

Assignees
No one assigned
Labels
component:system System design and integration. (auto-assigned) run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) type:documentation Creating or refining documentation. (auto-assigned)
Projects
Software Working Group
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sasakisasaki @mitsudome-r @ito-san