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

Add major version to the protobuf package #77

Closed
tiyash-basu-frequenz opened this issue Aug 2, 2023 · 0 comments · Fixed by #151
Closed

Add major version to the protobuf package #77

tiyash-basu-frequenz opened this issue Aug 2, 2023 · 0 comments · Fixed by #151
Labels
part:protobuf Affects the protocol buffer definition files priority:high Address this as soon as possible type:enhancement New feature or enhancement visitble to users
Milestone

Comments

@tiyash-basu-frequenz
Copy link
Contributor

What's needed?

According to https://cloud.google.com/apis/design/versioning, All Google API interfaces must provide a major version number, which is encoded at the end of the protobuf package. For an example, look here. Also, note how this affects the directory structure there (files in version 2 go into a directory named v2).

We do not do this ATM, as is evident here. We need to do this before we make the first stable release (v1.0.0).

Proposed solution

As mentioned here, look here for an example.

Use cases

This achieves two objectives:

  1. services, in theory, could start supporting multiple major versions, to support clients while they transition.
  2. adopt it as a standard in the organization, regardless of whether point 1 is valid for some services or not.

Alternatives and workarounds

No response

Additional context

No response

@tiyash-basu-frequenz tiyash-basu-frequenz added part:❓ We need to figure out which part is affected priority:❓ We need to figure out how soon this should be addressed type:enhancement New feature or enhancement visitble to users labels Aug 2, 2023
@tiyash-basu-frequenz tiyash-basu-frequenz added this to the v1.0.0 milestone Aug 2, 2023
@tiyash-basu-frequenz tiyash-basu-frequenz changed the title Version the protobuf package Add major version to the protobuf package Aug 2, 2023
@tiyash-basu-frequenz tiyash-basu-frequenz added priority:high Address this as soon as possible part:protobuf Affects the protocol buffer definition files and removed part:❓ We need to figure out which part is affected priority:❓ We need to figure out how soon this should be addressed labels Aug 7, 2023
@tiyash-basu-frequenz tiyash-basu-frequenz linked a pull request Oct 5, 2023 that will close this issue
@tiyash-basu-frequenz tiyash-basu-frequenz modified the milestones: v1.0.0, v0.16.0 Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part:protobuf Affects the protocol buffer definition files priority:high Address this as soon as possible type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant