Skip to content

docs: add dedicated tools and settings pages for stack configuration#2240

Open
osterman wants to merge 1 commit intomainfrom
osterman/deps-settings-tools
Open

docs: add dedicated tools and settings pages for stack configuration#2240
osterman wants to merge 1 commit intomainfrom
osterman/deps-settings-tools

Conversation

@osterman
Copy link
Member

@osterman osterman commented Mar 22, 2026

what

  • Added website/docs/stacks/dependencies/tools.mdx — dedicated page for dependencies.tools configuration (version constraints, scopes, merge behavior, toolchain integration)
  • Added website/docs/stacks/components/settings.mdx — dedicated page for *.settings configuration (validation, templates, integrations, atlantis, depends_on, custom keys)
  • Slimmed website/docs/stacks/dependencies/index.mdx to an overview with quick examples linking to the dedicated tools and components pages

why

  • The dependencies sidebar had components but no tools page — tool dependency docs were inlined in the overview
  • The components sidebar had *.metadata but no *.settings page — settings docs were scattered across integration pages
  • Adds parity so both dependency types and both component config sections have dedicated reference pages
  • Clarifies the relationship between atmos.yaml settings and stack-level settings (some keys like templates work at both levels, others like list_merge_strategy are global-only)

references

  • Follows patterns from existing components.mdx and metadata.mdx pages

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide for configuring component settings in Atmos manifests, including use cases, scope levels, and merge behavior
    • Added dedicated documentation for tool dependencies configuration and management
    • Reorganized dependencies overview to clarify component vs. tool dependencies with improved cross-references and examples

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@osterman osterman added the no-release Do not create a new release (wait for additional code changes) label Mar 22, 2026
@github-actions github-actions bot added the size/m Medium size PR label Mar 22, 2026
@mergify
Copy link

mergify bot commented Mar 22, 2026

Important

Cloud Posse Engineering Team Review Required

This pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes.

To expedite this process, reach out to us on Slack in the #pr-reviews channel.

@mergify mergify bot added the needs-cloudposse Needs Cloud Posse assistance label Mar 22, 2026
@github-actions
Copy link

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6db81d3f-b534-4ed6-9b04-7a2603b44d95

📥 Commits

Reviewing files that changed from the base of the PR and between e5dc1bd and 75a609d.

📒 Files selected for processing (3)
  • website/docs/stacks/components/settings.mdx
  • website/docs/stacks/dependencies/index.mdx
  • website/docs/stacks/dependencies/tools.mdx

📝 Walkthrough

Walkthrough

This PR adds new documentation for component settings configuration and refactors the dependencies documentation by creating a dedicated tool dependencies page and reorganizing the main dependencies overview to distinguish tool version requirements from component execution-order dependencies.

Changes

Cohort / File(s) Summary
Settings Documentation
website/docs/stacks/components/settings.mdx
New comprehensive documentation page defining the settings section in component manifests, including use cases (validation, templates, CI/CD integration), multi-level configuration scope, merge semantics, recognized keys (validation, templates, integrations, atlantis, depends_on), and custom key pass-through with YAML examples.
Dependencies Restructuring
website/docs/stacks/dependencies/index.mdx
Streamlined overview page emphasizing component execution ordering and deployment orchestration; removed detailed tool dependencies sections with a redirect to dedicated tool dependencies page; clarified dependencies.components as the mechanism for component relationships; removed Best Practices section.
Tool Dependencies Documentation
website/docs/stacks/dependencies/tools.mdx
New dedicated page documenting dependencies.tools configuration, supported constraint formats (exact versions, latest, semver-style), multi-level scope inheritance, automatic tool installation/usage, and best practices with comprehensive YAML examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • aknysh
  • kevcube
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add dedicated tools and settings pages for stack configuration' clearly and concisely summarizes the main change—adding two new documentation pages for tools and settings with an overview page refactor.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch osterman/deps-settings-tools

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Mar 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.04%. Comparing base (5d12f9d) to head (75a609d).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2240      +/-   ##
==========================================
+ Coverage   76.89%   77.04%   +0.14%     
==========================================
  Files        1003     1012       +9     
  Lines       95524    96029     +505     
==========================================
+ Hits        73456    73982     +526     
+ Misses      17805    17784      -21     
  Partials     4263     4263              
Flag Coverage Δ
unittests 77.04% <ø> (+0.14%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 33 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment on lines +32 to +41
<File title="stacks/orgs/acme/_defaults.yaml">
```yaml
settings:
templates:
settings:
gomplate:
enabled: true
validation:
schema:
enabled: true
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is a misinterpretation. I believe this is only valid in atmos.yaml. Please check

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-cloudposse Needs Cloud Posse assistance no-release Do not create a new release (wait for additional code changes) size/m Medium size PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant