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

[chore][VERSIONING.md] Add long term support policy #11001

Merged
merged 14 commits into from
Sep 20, 2024

Conversation

mx-psi
Copy link
Member

@mx-psi mx-psi commented Aug 29, 2024

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.

Link to tracking issue

Fixes #10004

@mx-psi mx-psi requested review from a team and codeboten August 29, 2024 10:09
@mx-psi mx-psi changed the title WIP [chore][VERSIONING.md] Add long term support policy Aug 29, 2024
@mx-psi mx-psi requested a review from jpkrohling August 29, 2024 10:12
@mx-psi mx-psi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Aug 29, 2024
@mx-psi
Copy link
Member Author

mx-psi commented Aug 29, 2024

cc @open-telemetry/collector-approvers @open-telemetry/collector-contrib-approvers

Copy link

codecov bot commented Aug 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.28%. Comparing base (6029f31) to head (8205489).
Report is 36 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
@mx-psi mx-psi requested a review from atoulme September 2, 2024 11:57
@mx-psi mx-psi linked an issue Sep 2, 2024 that may be closed by this pull request
Copy link
Member

@songy23 songy23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved

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.
Copy link
Contributor

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

Copy link
Contributor

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?

Copy link
Member Author

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.

Copy link
Member Author

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!

@atoulme
Copy link
Contributor

atoulme commented Sep 9, 2024

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.

Copy link
Contributor

@tiffany76 tiffany76 left a 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.

VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
VERSIONING.md Outdated Show resolved Hide resolved
@mx-psi
Copy link
Member Author

mx-psi commented Sep 16, 2024

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.

Done!

@mx-psi mx-psi requested a review from codeboten September 16, 2024 10:54
@mx-psi
Copy link
Member Author

mx-psi commented Sep 17, 2024

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

@mx-psi mx-psi merged commit 07c3e17 into open-telemetry:main Sep 20, 2024
48 of 49 checks passed
@mx-psi mx-psi deleted the mx-psi/1.0-support-policy branch September 20, 2024 09:55
@github-actions github-actions bot added this to the next release milestone Sep 20, 2024
HongChenTW pushed a commit to HongChenTW/opentelemetry-collector that referenced this pull request Dec 19, 2024
…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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Define support guidelines for major revisions Define minimum supported period for 1.0
10 participants