Updating method definitions to reflect contribution guide changes #4865
Conversation
|
It should be going through a deprecation process established recently for this repo https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#breaking-changes |
Codecov Report
@@ Coverage Diff @@
## main #4865 +/- ##
=======================================
Coverage 90.64% 90.64%
=======================================
Files 180 180
Lines 10627 10627
=======================================
Hits 9633 9633
Misses 776 776
Partials 218 218
Continue to review full report at Codecov.
|
|
@dmitryax, I am not entirely keen on adding test coverage for the deprecated method wrappers since it would trip over the linter (gosec) though I am not sure if that is reasonable. |
config/confighttp/confighttp.go
Outdated
| // DefaultHTTPClientSettings returns HTTPClientSettings type object with | ||
| // Deprecated: [v0.45.0] Use NewDefaultHTTPClientSettings instead. | ||
| func DefaultHTTPClientSettings() HTTPClientSettings { | ||
| return NewDefaultHTTPClientSettings() |
There was a problem hiding this comment.
Using alias will make codecov happy
var DefaultHTTPClientSettings = NewDefaultHTTPClientSettings
There was a problem hiding this comment.
If this works, mind if I update the recommendation inside the contribution guide?
There was a problem hiding this comment.
Go for it in a separate PR :)
MovieStoreGuy
force-pushed
the
smarciniak/update-method-signatures
branch
from
ad2e9bf
to
23012cc
Compare
MovieStoreGuy
force-pushed
the
smarciniak/update-method-signatures
branch
from
23012cc
to
9c8921e
Compare
|
@bogdandrutu , rebased with main and updated the deprecated version numbers. |
|
A CHNAGELOG entry would make this PR ready to merge :) |
MovieStoreGuy
force-pushed
the
smarciniak/update-method-signatures
branch
2 times, most recently
from
0efdb09
to
24387eb
Compare
MovieStoreGuy
force-pushed
the
smarciniak/update-method-signatures
branch
from
45cbac9
to
9b07d5f
Compare
Description:
Addresses how methods must be defined depending on their purpose according to the contribution guide.
Link to tracking Issue:
Closes #4471
Testing:
N/A
Documentation:
Already exists in the contribution guide.
I did have a thought of keeping the existing method but marking the exported method as deprecated to not immediately force changes inside the collector contrib on next release, not sure what is preferred here.