feat(mdatagen): add automatic feature gate documentation generation #14130
Conversation
This file contains hidden or 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
sAchin-680
force-pushed
the
feat/mdatagen-featuregates-docs
branch
3 times, most recently
from
1ba9385 to
cc3891a
Compare
Codecov Report❌ Patch coverage is
❌ Your patch check has failed because the patch coverage (94.87%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #14130 +/- ##
==========================================
- Coverage 92.25% 92.22% -0.04%
==========================================
Files 658 658
Lines 41184 41222 +38
==========================================
+ Hits 37996 38017 +21
- Misses 2182 2193 +11
- Partials 1006 1012 +6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
sAchin-680
force-pushed
the
feat/mdatagen-featuregates-docs
branch
from
58737ba to
0fe7f89
Compare
sAchin-680
requested review from
andrzej-stencel,
bogdandrutu,
dmathieu and
mx-psi
as code owners
Implements automatic documentation generation for component feature gates via mdatagen, addressing issue open-telemetry#14067. Changes: - Extended metadata-schema.yaml with feature_gates section - Added FeatureGate types and validation to metadata.go - Created documentation template for feature gates - Integrated into documentation generation pipeline - Added test data and test cases - Updated README with usage examples All tests passing (282 tests) and lint checks clean. Signed-off-by: SACHIN <[email protected]>
Fix import grouping to properly separate standard library imports from third-party imports. This resolves the goimpi check failure in CI. Signed-off-by: SACHIN <[email protected]>
Signed-off-by: SACHIN <[email protected]>
sAchin-680
force-pushed
the
feat/mdatagen-featuregates-docs
branch
from
0fe7f89 to
ca8e3eb
Compare
Add test cases covering all validation scenarios: - Valid alpha and stable gates - Empty description error - Invalid stage error - Version format validation (missing 'v' prefix) - to_version requirement for stable/deprecated gates - Empty gate ID validation Achieves 100% coverage for validateFeatureGates function. Signed-off-by: SACHIN KUMAR <[email protected]>
mx-psi
reviewed
Nov 5, 2025
- Changed FeatureGates to []FeatureGate with ID field for preserved ordering - Added duplicate ID validation - Updated templates to iterate list using .ID - Added feature_gates section to schema and README - Updated tests and testdata - Removed accidentally committed mdatagen binary Addresses all feedback from @mx-psi on PR open-telemetry#14130
mx-psi
reviewed
Nov 6, 2025
- Remove changelog entry (mdatagen is internal tool) - Add validation: feature gates must be sorted by ID - Add validation: each feature gate must have reference_url - Add validation: ID must match regex ^[0-9a-zA-Z.]*$ - Add comprehensive tests for all validations - Revert unrelated formatting changes to package_test.go.tmpl
- Add 'mycomponent' to allowed status.class in metadata-schema.yaml - Add 'mycomponent' to cspell dictionary for spelling checks
Contributor
Author
|
Done in f92d1f8!
The schema file now has zero unrelated changes. |
codeboten
reviewed
Nov 12, 2025
Contributor
codeboten
left a comment
codeboten
left a comment
There was a problem hiding this comment.
Thanks @sAchin-680! Looks like just a space in the generated file's import list and it should be good to go to pass the CI checks
Contributor
Author
Hey @codeboten. Fixed the import spacing in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
Implements automatic documentation generation for component feature gates via mdatagen.
Component authors can now declare feature gates in
metadata.yaml, and mdatagen will automatically generate standardized markdown documentation including gate IDs, stages, descriptions, version information, and reference links.Key Changes:
metadata-schema.yamlwithfeature_gatessectionFeatureGatetypes with validation (required fields, valid stages, version format)Link to tracking issue
Fixes(edit by @mx-psi) Updates #14067Testing
TestRunContents/feature_gates.yamltest caseDocumentation
cmd/mdatagen/README.mdwith usage examplescmd/mdatagen/internal/testdata/documentation.md