-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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] Allow sometimes skipping deprecation process when adding variadic arguments #10041
[chore] Allow sometimes skipping deprecation process when adding variadic arguments #10041
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10041 +/- ##
==========================================
- Coverage 91.88% 91.87% -0.02%
==========================================
Files 360 360
Lines 16725 16725
==========================================
- Hits 15368 15366 -2
- Misses 1020 1021 +1
- Partials 337 338 +1 ☔ View full report in Codecov by Sentry. |
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 think this should still be considered a breaking change, it is not a common exception, and while it's not super frequent to pass functions as arguments in Go it can happen.
I would be in favor of adding an exception for making the two step deprecation process described on https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#breaking-changes for changes like this, while acknowledging this is still breaking
71152dd
to
66d71bf
Compare
Got it, I misunderstood the intent of this section. I've added a section to our contributing document instead. |
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.
Would be good to discuss this at the SIG this week to ensure everyone is in agreement on the exception
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.
Thanks @evan-bradley
…adic arguments (open-telemetry#10041) Call out that unnamed types, e.g. the function signature of an exported function, should not be relied upon by API consumers. In particular, updating a function to be variadic will break users who were depending on that function's signature. #### Link to tracking issue Helps open-telemetry#9041 Co-authored-by: Evan Bradley <evan-bradley@users.noreply.github.com> Co-authored-by: Pablo Baeyens <pablo.baeyens@datadoghq.com> Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
Description
Call out that unnamed types, e.g. the function signature of an exported function, should not be relied upon by API consumers. In particular, updating a function to be variadic will break users who were depending on that function's signature.
Link to tracking issue
Helps #9041