Document missing component metadata fields#1840
Conversation
|
Warning Rate limit exceeded@osterman has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 43 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (8)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
- Move metadata.mdx to stacks/components/ with sidebar label `components.*.metadata` - Add documentation for terraform_workspace field (literal workspace override) - Add documentation for terraform_workspace_pattern field (pattern with context tokens) - Add documentation for custom field (user extension point for arbitrary metadata) - Update all cross-references to use new /stacks/components/component-metadata URL - Add cross-reference from workspaces.mdx back to metadata page 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
b39848a to
cab4f7d
Compare
Dependency Review✅ No vulnerabilities or license issues found.Scanned FilesNone |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1840 +/- ##
==========================================
+ Coverage 72.13% 72.17% +0.04%
==========================================
Files 475 475
Lines 45713 45713
==========================================
+ Hits 32974 32993 +19
+ Misses 10118 10099 -19
Partials 2621 2621
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Brings in recent changes from main including: - Native devcontainer support (#1697) - Version constraint validation for atmos.yaml (#1759) - Fix for empty backend.tf.json generation (#1833) - Document missing component metadata fields (#1840) Resolved conflicts: - cmd/root.go: Added both devcontainer and init/scaffold imports - Test snapshot will be regenerated to include devcontainer command Note: Pre-existing linting issues in init/scaffold experimental code remain and will be addressed before merging to main. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
what
metadatadocumentation tostacks/components/with clearer sidebar labelcomponents.*.metadataterraform_workspace,terraform_workspace_pattern, andcustomwhy
Component metadata is currently under-documented. The schema defines 8 metadata fields, but the documentation only covered 5. The location
stacks/metadata.mdxalso implied stack-level configuration, creating confusion. Moving tostacks/components/metadata.mdxclarifies that metadata is only valid undercomponents.terraform.<name>.metadata.references
pkg/datafetcher/schema/atmos/manifest/1.0.jsonwebsite/docs/components/terraform/workspaces.mdx