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 system_monitor #9975

Closed
wants to merge 9 commits into from
Closed

feat: apply autoware_ prefix for system_monitor #9975

wants to merge 9 commits into from

Conversation

sasakisasaki
Copy link
Contributor

@sasakisasaki sasakisasaki commented Jan 19, 2025 •
edited
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.

Related Links

How was this PR tested?

Just now, tests are ongoing. It is appreciated if you find any issues and so on at this stage.

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.

  • 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 system_monitor needs to modify their code. This is maybe kind of non quick-win task.

@sasakisasaki
feat(system_monitor): apply autoware_ prefix (see below):
68c6926 
  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 <junya.sasaki@tier4.jp>
@github-actions github-actions bot added the component:system System design and integration. (auto-assigned) label 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:

pre-commit-ci bot and others added 7 commits January 19, 2025 13:49
@pre-commit-ci
style(pre-commit): autofix
f390481
@sasakisasaki
Merge branch 'main' into feat-apply-autoware-prefix-for-system-system…
c799f08 
…-monitor

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
bug(system_monitor): fix following bugs:
0da27c2 
  * Inconsistent namespacings
  * Wrongly updated copyrights
  * Missing dependencies

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
rename(system_monitor): move headers under include/autoware
692d720 
  * Fixes due to this changes for .hpp/.cpp files will be applied in the next commit

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
fix(system_monitor): fix include header paths:
90f4913 
  * To follow the previous commit

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
rename: system_monitor => autoware_system_monitor
6625131 
Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@sasakisasaki
Merge branch 'feat-apply-autoware-prefix-for-system-system-monitor' o…
1f18bf2 
…f github.com:sasakisasaki/autoware.universe into feat-apply-autoware-prefix-for-system-system-monitor

Signed-off-by: Junya Sasaki <junya.sasaki@tier4.jp>
@github-actions github-actions bot added type:documentation Creating or refining documentation. (auto-assigned) component:launch Launch files, scripts and initialization tools. (auto-assigned) labels Jan 23, 2025
@sasakisasaki sasakisasaki changed the title [WIP] feat: apply autoware_ prefix for system_monitor feat: apply autoware_ prefix for system_monitor Jan 24, 2025
@sasakisasaki sasakisasaki marked this pull request as ready for review January 24, 2025 02:21
@sasakisasaki sasakisasaki added the run:build-and-test-differential Mark to enable build-and-test-differential workflow. (used-by-ci) label Jan 24, 2025
@sasakisasaki
Copy link
Contributor Author

Let me close this PR. As this PR contains many un-related fixes, I have re-created a new PR as this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ito-san ito-san Awaiting requested review from ito-san ito-san is a code owner

@TetsuKawa TetsuKawa Awaiting requested review from TetsuKawa TetsuKawa is a code owner

Assignees
No one assigned
Labels
component:launch Launch files, scripts and initialization tools. (auto-assigned) 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
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@sasakisasaki