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

Prefix packages with autoware_ prefix and keep code in autoware namespace #4569

Open
esteve opened this issue Mar 27, 2024 · 8 comments
Open

Prefix packages with autoware_ prefix and keep code in autoware namespace #4569

esteve opened this issue Mar 27, 2024 · 8 comments
Assignees
@esteve
Labels
component:system System design and integration.

Comments

@esteve
Copy link
Contributor

esteve commented Mar 27, 2024 •
edited
Loading

Checklist

  • I've read the contribution guidelines.
  • I've searched other issues and no duplicate issues were found.
  • I've agreed with the maintainers that I can plan this task.

Description

See https://github.com/orgs/autowarefoundation/discussions/4097

Purpose

Keep Autoware code clearly separate from other projects by adding appropriate namespacing and prefixes

Possible approaches

Add autoware namespace and autoware_ prefix for package names

Definition of done

All packages are prefixed and the code is in the autoware namespace

List of packages in reverse topological order:
@esteve esteve self-assigned this Mar 27, 2024
This was referenced Mar 27, 2024
Closed
Merged
Closed
Merged
@idorobotics idorobotics added the component:system System design and integration. label Apr 4, 2024
@esteve esteve mentioned this issue Apr 15, 2024
Merged
4 tasks
@xmfcx
Copy link
Contributor

xmfcx commented May 2, 2024

Following up from:

We should prefix the package folder names with autoware_ too.

The package name in the package.xml file should match its parent folder.

I might have missed something too, open to discussion.

@esteve
Copy link
Contributor Author

esteve commented May 2, 2024

@xmfcx I've been waiting for feedback from the TierIV engineers regarding renaming the folders. @mitsudome-r do you have any updates? Thanks.

@xmfcx
Copy link
Contributor

xmfcx commented May 2, 2024 •
edited
Loading

I would like to change it and see the response in this case. And solve the issues after they arise.

main branch is a development branch and this is expected.

@mitsudome-r
Copy link
Member

I think we can move on with changing the package folder name as well.
However, we did have some concerns about the changing the package names & include folder structure for the packages in autoware_common repository and also the packages with tier4_ prefix.

https://github.com/autowarefoundation/autoware_common

This was referenced May 7, 2024
Merged
Merged
@xmfcx xmfcx mentioned this issue May 8, 2024
Merged
4 tasks
This was referenced May 28, 2024
Merged
Merged
Merged
Merged
This was referenced May 30, 2024
Merged
Merged
@esteve esteve mentioned this issue Jun 5, 2024
Merged
4 tasks
This was referenced Jun 6, 2024
Merged
Merged
@rej55 rej55 mentioned this issue Jun 6, 2024
Merged
7 tasks
This was referenced Jun 6, 2024
Merged
Merged
@rej55 rej55 mentioned this issue Jun 6, 2024
Merged
7 tasks
This was referenced Jun 6, 2024
Merged
Merged
Merged
This was referenced Jun 24, 2024
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
@technolojin
Copy link

@esteve @xmfcx @mitsudome-r
We (TIER IV perception engineering team) decided to separate tasks of the namespace fix and the package name fix.
The related PRs will refer this issue, so that the progress can be tracked.

@esteve esteve mentioned this issue Jun 25, 2024
Merged
4 tasks
This was referenced Jun 26, 2024
Merged
Merged
Merged
Merged
Closed
Merged
Merged
Merged
This was referenced Jul 2, 2024
Open
Merged
Merged
Open
Open
@technolojin technolojin mentioned this issue Jul 3, 2024
Open
This was referenced Jul 3, 2024
Open
Open
@technolojin
Copy link

Detail of #4569 (comment)

In /perception, the package name will be changed after all the packages are ready.
The separation is to minimize mistakes on namespace changes from package renaming. If those two works are done in the same time, complexity of the work and the test procedure may increases.

  • the old package remains in your build/install folder
  • namespace renaming cannot be tested when the old package is remained
  • do clean build every time is inefficient. manual cleaning is needed every time, every working branch changes

When the relevant packages are ready (namespace fix), the package renaming will be done in a concentrated timing.

@technolojin technolojin mentioned this issue Jul 4, 2024
Draft
@esteve
Copy link
Contributor Author

esteve commented Jul 4, 2024

@technolojin thanks for elaborating, but I have a question about this:

The separation is to minimize mistakes on namespace changes from package renaming. If those two works are done in the same time, complexity of the work and the test procedure may increases.

Why is that? We've done that with the planning packages and many others and we haven't had a problem. What makes the perception packages different? I've moved the header files and renamed the packages for some packages in the perception subsystem in autowarefoundation/autoware.universe#7809 autowarefoundation/autoware.universe#7808 and autowarefoundation/autoware.universe#7804 and it doesn't seem to have caused any issues.

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

@esteve esteve

Labels
component:system System design and integration.
Projects
Autoware Labs
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
5 participants
@esteve @xmfcx @idorobotics @technolojin @mitsudome-r