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

[Change Proposal] Centralize conventions for "release badges" #286

Open
jsoriano opened this issue Feb 28, 2022 · 1 comment
Open

[Change Proposal] Centralize conventions for "release badges" #286

jsoriano opened this issue Feb 28, 2022 · 1 comment
Labels
discuss Issue needs discussion

Comments

@jsoriano
Copy link
Member

After #225, the stability level of a package is decided by semantic versioning. Semantic versioning by itself only establishes that a package is stable if its version is not 0.x and it doesn't contain prerelease labels. If more prerelease levels are needed, conventions need to be defined.

As part of elastic/kibana#122973, we defined some conventions for the "release badges" that should be displayed to users based on semantic versioning:

  • 0.x versions -> "Technical Preview"
  • x.x.x-beta... -> "Beta"
  • x.x.x-rc... -> "Release Candidate"
  • x.x.x-preview... -> "Technical Preview"
  • Other prerelease labels won't be allowed in the spec, but if they appear, default to "Beta".

We have found that this convention is needed in several user-facing places, at least in the following ones:

As this is not expected to change frequently, an option can be to have this mapping implemented on each place where it is needed, but this can lead to incoherences, so it'd be nice to have this in a central place.

The natural place to have this kind of conventions would be in the spec, but this cannot be easily consumed by other tools.

Another place, as proposed in elastic/kibana#122973 (comment), can be the package-registry, that in principle all the other services use for packages obtained from there.

@jsoriano
Copy link
Member Author

As discussed in elastic/kibana#122973 (comment), I consider this tricky because this is needed mostly for UI reasons, and how this information is displayed in different components can be different.

@jsoriano jsoriano self-assigned this Feb 28, 2022
@jsoriano jsoriano removed their assignment Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Issue needs discussion
Projects
None yet
Development

No branches or pull requests

1 participant