-
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
[configtls] mark module as stable #10344
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10344 +/- ##
=======================================
Coverage 92.36% 92.36%
=======================================
Files 386 386
Lines 18402 18402
=======================================
Hits 16997 16997
Misses 1052 1052
Partials 353 353 ☔ View full report in Codecov by Sentry. |
Reviewing this PR inspired #10358, that removes the dependency on confmap from this configtls |
Thank you @codeboten , indeed the dependency on confmap was only through tests. |
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.
I support this:
- No explicit or implicit dependencies on unstable modules (other than via the fact that this has
mapstructure
tags) - No 1.0 issues remaining in the tracker
- No experimental or TODO symbols
- Structs follow correct naming and methods have
context.Context
on them
cc @open-telemetry/collector-approvers
@mx-psi @songy23 @atoulme One thing to keep in mind is that this package does expose |
@codeboten Right, I forgot about this. I don't see us changing |
Is changing tags on a struct field a breaking change? The go API is unchanged, right? |
@atoulme it's currently listed in versioning.md as breaking change https://github.com/open-telemetry/opentelemetry-collector/blob/main/VERSIONING.md#configuration-structures |
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.
No plan to move away from mapstructure
struct tags at this point 👍🏻
We had some discussion about bumping I am not sure how we should best clarify this on |
…wed (#10460) <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description <!-- Issue number if applicable --> We have recently discussed bumping the minimum TLS version to follow security best practices. Since we are about to stabilize `configtls` (see #10344), I raised the question of whether this would be a breaking change that should be done before 1.0. I argue that we should be allowed to do this after 1.0 because: - The Go 1 version compatibility doc states > Security. A security issue in the specification or implementation may come to light whose resolution requires breaking compatibility. We reserve the right to address such security issues. - The Go team has made [similar changes](golang/go#45428) in the past for Go as a whole While this is not a security issue but a security best practice, the golang/go issue seems to indicate that changes like this would be in the spirit of the Go 1 version compatibility promise.
Description
Mark module as stable.
Link to tracking issue
Fixes #9377