[VERSIONING.md] Reorganize and clarify compatibility guarantees #8812
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #8812 +/- ##
=======================================
Coverage 91.57% 91.57%
=======================================
Files 316 316
Lines 17147 17147
=======================================
Hits 15702 15702
Misses 1150 1150
Partials 295 295 ☔ View full report in Codecov by Sentry. |
songy23
reviewed
Nov 8, 2023
Co-authored-by: Yang Song <[email protected]>
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
atoulme
approved these changes
Dec 5, 2023
codeboten
approved these changes
Dec 7, 2023
TylerHelmuth
reviewed
Dec 7, 2023
Comment on lines
+29
to
+30
| * **String representation**. The `String` method of any struct is intended to be human-readable and may change its output | ||
| in any way. |
| Unless otherwise specified in the documentation, the following may change in any way between minor versions: | ||
| * **String representation**. The `String` method of any struct is intended to be human-readable and may change its output | ||
| in any way. | ||
| * **Go version compatibility**. Removing support for an unsupported Go version is not considered a breaking change. |
There was a problem hiding this comment.
Does unsupported here mean unsupported by Go or unsupported by us.
There was a problem hiding this comment.
Supported by the Go team. This is mostly a rephrasing of what is already on the README https://github.com/open-telemetry/opentelemetry-collector?tab=readme-ov-file#compatibility
TylerHelmuth
approved these changes
Dec 7, 2023
dmitryax
approved these changes
Dec 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description: Reorganize
VERSIONING.md, specify compatibility guarantees that have already been discussed and answer questions on #8002.Three new guarantees in the document had already been discussed elsewhere:
pdata's 1.0 (consensus seems to be that it should not).Regarding the questions mentioned on #8002:
Generally, yes except when the configuration was already invalid (i.e. the Collector did not work properly with it).
I did not add anything for this one. I think we should discuss it, but:
NewDefault...for all configurations (e.g. forconfignet.TCPAddr, what would the default be?)Validate, and not throughNewDefault....NewDefaultmay help but ultimately we need to verify throughValidate.This was already in this document, where we had decided that adding new fields was okay. I think it would be too stringent to bar us from adding new fields.
Link to tracking Issue: Fixes #8002