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

Unified versioning across all crates #2084

Closed
cijothomas opened this issue Sep 7, 2024 · 3 comments
Closed

Unified versioning across all crates #2084

cijothomas opened this issue Sep 7, 2024 · 3 comments

Comments

@cijothomas
Copy link
Member

Problem:
Currently, each crate in this repo is independently versioned. This makes it difficult to track issues when users report issues, as we need to ask for the version of every individual crate before we can investigate. This is unnecessary overhead. When we do a release, it is equally hard to "name" the overall release. We have been using the pattern "Release ABC", where ABC is the version of the API crate.

Proposal:
Proposing that we use a single version number(Major.Minor) for all crates in this repo. This would mean that when one crate is updated, all crates would use the same version number (Major.Minor), regardless of whether they had changes or not. Although this could result in “empty” releases for crates without actual changes, such occurrences are extremely rare. A hotfix for a leaf crate (which no other crate depends on) would only update a patch version number, so no need to force a version bump for all other crates, as the proposal is to use uniform Major.Minor for all crates, and patch number could be different if there is a need.

Once we reach the 1.0 release, we can revisit the versioning strategy if necessary. However, unifying the versions now simplifies pre-1.0 development and testing, which is our current focus.

Please share thoughts/feedback on this. If no concerns, I plan to use this approach for the release planned now. (Release was originally planned for earlier this week, but I expect to do it by Monday)

@TommyCpp
Copy link
Contributor

TommyCpp commented Sep 9, 2024

Related to #1966

@lalitb
Copy link
Member

lalitb commented Sep 9, 2024

I second this, assuming for version x.y.z:

  • The y version would stay consistent across all crates.
  • Each crate can independently release updates for the z version.
  • This approach applies with x=0 for now, with a review planned after reaching x=1.

@cijothomas
Copy link
Member Author

Fixed via #2088

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants