-
Notifications
You must be signed in to change notification settings - Fork 162
Open
Labels
component:systemSystem design and integration.System design and integration.status:staleInactive or outdated issues. (auto-assigned)Inactive or outdated issues. (auto-assigned)type:documentationCreating or refining documentation.Creating or refining documentation.type:new-featureNew functionalities or additions, feature requests.New functionalities or additions, feature requests.
Description
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
This proposal outlines the need for a defined versioning system for autoware_msgs. It will also cover how various packages and tools that interact with autoware_msgs can adapt to this versioning system.
This proposal serves as a follow-up from:
cc. @mitsudome-r @isamu-takagi @wep21 @kenji-miyake @TakaHoribe @mehmetdogru @kaancolak @miursh
Purpose
- Establish a robust version control mechanism for
autoware_msgsto improve source control and make updates transparent and trackable. - Define a transition process for tools/packages that interact with
autoware_msgsto adapt to changes or updates, ensuring smooth integration and avoiding potential conflicts. - Create a solid foundation for future development and expansion of the
autoware_msgspackage.
Possible approaches
-
Semantic Versioning (SemVer): Implement Semantic Versioning (major.minor.patch), providing clarity about backward compatibility and allowing easier integration for packages interacting with
autoware_msgs. -
Release Branching: Create release branches for
autoware_msgsfor each major version. This allows for bug fixes and minor updates to be added to previous versions without disturbing the main development.
Definition of done
- A comprehensive document outlining the chosen versioning system and the rationale behind it is drafted.
- Autoware developers have reviewed and approved the proposal.
- The document is merged into the project repository as an official guide for
autoware_msgsversioning system.
kenji-miyake, mitsudome-r and HansRobo
Metadata
Metadata
Assignees
Labels
component:systemSystem design and integration.System design and integration.status:staleInactive or outdated issues. (auto-assigned)Inactive or outdated issues. (auto-assigned)type:documentationCreating or refining documentation.Creating or refining documentation.type:new-featureNew functionalities or additions, feature requests.New functionalities or additions, feature requests.