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.

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

Establish and document the versioning system for the autoware_msgs #379

Open
3 of 6 tasks
xmfcx opened this issue May 26, 2023 · 2 comments
Open
3 of 6 tasks

Establish and document the versioning system for the autoware_msgs #379

xmfcx opened this issue May 26, 2023 · 2 comments
Assignees
Labels
component:system System design and integration. status:stale Inactive or outdated issues. (auto-assigned) type:documentation Creating or refining documentation. type:new-feature New functionalities or additions, feature requests.

Comments

@xmfcx
Copy link
Contributor

xmfcx commented May 26, 2023

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_msgs to improve source control and make updates transparent and trackable.
  • Define a transition process for tools/packages that interact with autoware_msgs to adapt to changes or updates, ensuring smooth integration and avoiding potential conflicts.
  • Create a solid foundation for future development and expansion of the autoware_msgs package.

Possible approaches

  1. Semantic Versioning (SemVer): Implement Semantic Versioning (major.minor.patch), providing clarity about backward compatibility and allowing easier integration for packages interacting with autoware_msgs.

  2. Release Branching: Create release branches for autoware_msgs for 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_msgs versioning system.
@xmfcx xmfcx added type:documentation Creating or refining documentation. type:new-feature New functionalities or additions, feature requests. component:system System design and integration. labels May 26, 2023
@xmfcx xmfcx self-assigned this May 26, 2023
@xmfcx
Copy link
Contributor Author

xmfcx commented May 26, 2023

I will create a PR to start with, any opinion is welcome before or during the PR.

@stale
Copy link

stale bot commented Jul 25, 2023

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the status:stale Inactive or outdated issues. (auto-assigned) label Jul 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:system System design and integration. status:stale Inactive or outdated issues. (auto-assigned) type:documentation Creating or refining documentation. type:new-feature New functionalities or additions, feature requests.
Projects
None yet
Development

No branches or pull requests

1 participant