-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
[chore][VERSIONING.md] Add long term support policy #11001
[chore][VERSIONING.md] Add long term support policy #11001
Conversation
cc @open-telemetry/collector-approvers @open-telemetry/collector-contrib-approvers |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #11001 +/- ##
=======================================
Coverage 92.28% 92.28%
=======================================
Files 413 413
Lines 19760 19760
=======================================
Hits 18236 18236
Misses 1152 1152
Partials 372 372 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Juraci Paixão Kröhling <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
||
The OpenTelemetry Collector SIG provides long term support for stable binary distributions of the OpenTelemetry Collector and its components. The following policies apply to long term support for any major version starting on v1: | ||
|
||
* A binary distribution of the OpenTelemetry Collector MUST be supported for a minimum of **one year** after the release of the next major version of said distribution. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be good to have a section in this doc specifically defining what "supported" means
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When does support for a binary end?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be good to have a section in this doc specifically defining what "supported" means
The intention was that this sentence above:
critical bugs and security vulnerabilities MUST be addressed
was the definition of supported (or, at least, a minimum criteria for what supported means). We may do more than this, but that's the minimum.
When does support for a binary end?
This was also meant to be already covered in the text by this:
A binary distribution of the OpenTelemetry Collector MUST be supported for a minimum of one year after the release of the next major version of said distribution.
So, basically, we support the distro indefinitely until we release the next major version, after which we support it for one more year.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@codeboten if you think we should file an issue to continue discussing this please do so!
Co-authored-by: Alex Boten <[email protected]>
I would add to this document a paragraph that explains that this policy is the current consensus, but it can change in the future, based on project direction and SIG discussions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few copy-edit suggestions.
Co-authored-by: Tiffany Hrabusa <[email protected]>
Done! |
I'll merge this by end of week unless there are further comments, we can iterate on the wording and clarify support more but this feels like it is good enough for a first version given the number of approvals |
…1001) <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description Adds support policy for Collector SIG software artifacts with the following principles: - Support means that we will, at a minimum, fix critical bugs and security issues. We MAY fix other bugs and/or add features if needed (e.g. because a feature eases transition to a v2), but this is not required - We support artifacts for end-users for longer - Artifacts may contain sub-components that are not stable. The important bit is that users can easily tell when something is unstable. <!-- Issue number if applicable --> #### Link to tracking issue Fixes open-telemetry#10004 --------- Co-authored-by: Tyler Helmuth <[email protected]> Co-authored-by: Juraci Paixão Kröhling <[email protected]> Co-authored-by: Alex Boten <[email protected]> Co-authored-by: Tiffany Hrabusa <[email protected]>
Description
Adds support policy for Collector SIG software artifacts with the following principles:
Link to tracking issue
Fixes #10004