Update Atmos stack manifest JSON schema. Fix docs #842
Conversation
aknysh
added
the
no-release
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces updates to the JSON schema for Atmos Stack Manifest files by adding a new boolean property, Changes
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (5)
🚧 Files skipped from review as they are similar to previous changes (4)
🔇 Additional comments (2)examples/demo-localstack/schemas/atmos-manifest.json (2)
The new boolean property provides a clean way to toggle components without removing their configuration. This follows the principle of maintaining configuration as code while allowing for dynamic control.
The updated descriptions for ✅ Verification successfulProperty descriptions are consistently applied across all schema files! ✅ The verification shows that all schema files have identical descriptions for the properties:
🏁 Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Description: Verify consistent metadata property descriptions across schema files
# Find all atmos manifest schema files
echo "Checking schema files for consistent metadata descriptions..."
fd -e json -x grep -l "atmos-manifest" {} | while read -r file; do
echo "=== Checking $file ==="
# Check for consistent descriptions
jq -r '.definitions.metadata.properties | select(.) | {component,inherits,terraform_workspace,terraform_workspace_pattern} | .[] | .description' "$file"
done
Length of output: 2952 Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
examples/demo-localstack/schemas/atmos-manifest.json (1)
323-325: Well-structured schema addition for component enablement.The new
enabledboolean property in the metadata section provides a clean way to control component activation. This addition enhances the framework's flexibility without breaking existing configurations.Consider documenting common use cases for this flag, such as feature toggles or environment-specific component activation.
examples/demo-context/schemas/atmos-manifest.json (1)
323-325: Consider adding a description for the newenabledproperty.The implementation looks good, but adding a description would help users understand the purpose and behavior of this property.
"enabled": { - "type": "boolean" + "type": "boolean", + "description": "Controls whether the component is enabled or disabled in the stack" },
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (10)
examples/demo-context/schemas/atmos-manifest.json(1 hunks)examples/demo-helmfile/schemas/atmos-manifest.json(1 hunks)examples/demo-localstack/schemas/atmos-manifest.json(1 hunks)examples/quick-start-advanced/Dockerfile(1 hunks)examples/quick-start-advanced/stacks/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json(1 hunks)website/docs/core-concepts/components/terraform/backends.mdx(1 hunks)website/docs/core-concepts/stacks/overrides.mdx(1 hunks)website/docs/integrations/atlantis.mdx(1 hunks)website/docs/quick-start/advanced/configure-terraform-backend.mdx(1 hunks)website/static/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json(1 hunks)
🧰 Additional context used
📓 Learnings (1)
examples/quick-start-advanced/Dockerfile (2)
Learnt from: aknysh
PR: cloudposse/atmos#775
File: examples/quick-start-advanced/Dockerfile:9-9
Timestamp: 2024-11-12T05:52:05.088Z
Learning: It is acceptable to set `ARG ATMOS_VERSION` to a future version like `1.105.0` in `examples/quick-start-advanced/Dockerfile` if that will be the next release.
Learnt from: osterman
PR: cloudposse/atmos#801
File: examples/quick-start-advanced/Dockerfile:9-9
Timestamp: 2024-11-23T00:13:22.004Z
Learning: When updating the `ATMOS_VERSION` in Dockerfiles, the team prefers to pin to the next future version when the PR merges, even if the version is not yet released.
🔇 Additional comments (7)
examples/quick-start-advanced/Dockerfile (1)
9-9: LGTM! Version update aligns with team preferences.
The version bump to 1.122.0 follows the team's established practice of pinning to the next future version when the PR merges.
website/docs/core-concepts/stacks/overrides.mdx (1)
365-365: Documentation fix: Correct CLI command reference.
The command reference has been properly updated from atmosxw to atmos, ensuring accurate documentation.
examples/demo-helmfile/schemas/atmos-manifest.json (1)
323-325: Apply the same documentation improvement here.
For consistency with other schema files, consider adding a description for the enabled property.
examples/quick-start-advanced/stacks/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json (1)
323-325: Clean and well-structured schema addition!
The new enabled boolean property is correctly defined in the metadata section, maintaining the schema's structure and validation capabilities.
website/docs/quick-start/advanced/configure-terraform-backend.mdx (1)
158-159: Excellent documentation enhancement!
The added comment clearly explains alternative ways to set the auto_generate_backend_file option, improving user experience.
website/docs/core-concepts/components/terraform/backends.mdx (1)
105-106: Great consistency in documentation!
The added comment maintains consistency with the quick-start guide, ensuring users have a uniform understanding of the auto_generate_backend_file configuration across different sections.
website/docs/integrations/atlantis.mdx (1)
676-676: LGTM! Version update is consistent.
The Atmos version update from 1.121.0 to 1.122.0 aligns with the version changes made in the quick-start example Dockerfile.
website/static/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json
Outdated
Show resolved
Hide resolved
|
These changes were released in v1.123.0. |
what
why
metadata.enabledto the Atmos stack manifest validation schemaSummary by CodeRabbit
New Features
enabledproperty (boolean) to the metadata definition in various Atmos Stack Manifest JSON schemas, enhancing configuration capabilities.Documentation
overridessection in stack manifests.Chores