-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
[mdatagen] Add deprecation date and migration note fields for deprecated components #12464
base: main
Are you sure you want to change the base?
Conversation
fe6505a
to
e3b46d3
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12464 +/- ##
=======================================
Coverage 92.11% 92.11%
=======================================
Files 467 467
Lines 25252 25276 +24
=======================================
+ Hits 23260 23284 +24
Misses 1590 1590
Partials 402 402 ☔ 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.
this PR covers well what I was asking for. LGTM
1043c28
to
4181e95
Compare
I recommend we start adopting the additional yaml in contrib and make contrib tests pass, then merge this PR. We can do that with one PR per deprecated component:
|
4181e95
to
ab22bd5
Compare
Does this mean we should create and merge PRs like open-telemetry/opentelemetry-collector-contrib#38144? My concern is that contrib CI will be broken in that case but it looks like chicken-egg problem 🤔 . |
9299b25
to
57e163e
Compare
#12484 can remove this problem, please take a look? |
I'm not sure why would we allow random fields going forward. I would suggest the following:
|
Or we can just add |
I like this approach. I filed #12498 to update the schema without enforcing it. |
@ChrsMark please rebase this PR to fix conflicts, thanks! |
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description First PR to update metadata schema without enforcing it as suggested at #12464 (comment). <!-- Issue number if applicable --> #### Link to tracking issue Related to #12359 <!--Describe what testing was performed and which tests were added.--> #### Testing <!--Describe the documentation added.--> #### Documentation <!--Please delete paragraphs that you did not use before submitting.--> --------- Signed-off-by: ChrsMark <[email protected]>
57e163e
to
4ed4127
Compare
Signed-off-by: ChrsMark <[email protected]>
4ed4127
to
ab4f372
Compare
Description
This PR adds deprecation date and migration note fields for deprecated components as described at #12359.
Example metadata file:
Example README.md:
I'd appreciate any suggestions if there is a better way to represent this information in the markdown table.
Link to tracking issue
Fixes #12359
Testing
Added
Documentation
Added
/cc @atoulme who filed the feature request issue originally.