Skip to content

Conversation

@Benbentwo
Copy link
Member

@Benbentwo Benbentwo commented May 21, 2025

what

  • Partial revert of Custom Columns docs #1219
  • Currently, Custom Columns are not supported in all list commands, so we need to remove these from the docs until they are implemented.
    • atmos list vendor has code to support custom columns but upon further testing does not utilize the value and only prints based on if the column name is one of the predefined.
    • all other atmos list commands do not currently support custom columns.

why

  • Currently the docs will confuse and point at unimplemented features

references

Summary by CodeRabbit

  • Documentation
    • Removed all documentation related to customizing output columns for various atmos list commands.
    • Deleted YAML examples and explanations for defining custom columns in configuration files.
    • Eliminated redundant and duplicate example sections from command documentation.

@Benbentwo Benbentwo requested a review from a team as a code owner May 21, 2025 16:10
@Benbentwo Benbentwo requested a review from Cerebrovinny May 21, 2025 16:10
@github-actions
Copy link

Warning

This PR is blocked from merging because a required semver label is missing.

major, minor, patch, no-release

You'll need to add one before this PR can be merged.

@mergify mergify bot added the triage Needs triage label May 21, 2025
@mergify
Copy link

mergify bot commented May 21, 2025

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.

@codecov
Copy link

codecov bot commented May 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.15%. Comparing base (b6c2077) to head (3ce376f).
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1262      +/-   ##
==========================================
+ Coverage   48.06%   48.15%   +0.09%     
==========================================
  Files         233      233              
  Lines       25441    25441              
==========================================
+ Hits        12228    12251      +23     
+ Misses      11624    11597      -27     
- Partials     1589     1593       +4     
Flag Coverage Δ
unittests 48.15% <ø> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 21, 2025

📝 Walkthrough

Walkthrough

The changes remove all documentation related to customizing output columns for atmos list commands from multiple documentation files. Additionally, a YAML configuration example for vendor custom columns is added to a test fixture. No changes are made to exported or public entities.

Changes

Files Change Summary
website/docs/cli/commands/list/list-components.mdx
website/docs/cli/commands/list/list-metadata.mdx
website/docs/cli/commands/list/list-settings.mdx
website/docs/cli/commands/list/list-stacks.mdx
website/docs/cli/commands/list/list-values.mdx
website/docs/cli/commands/list/list-vars.mdx
Removed sections documenting how to customize output columns for each respective atmos list command.
website/docs/cli/commands/list/list-workflows.mdx Removed a duplicated example section on customizing workflow columns in the documentation.
website/docs/cli/commands/list/usage.mdx Removed all documentation on customizing columns, including examples, template variables, and troubleshooting tips.
tests/fixtures/scenarios/vendor/atmos.yaml Added a list subsection under vendor with column definitions for display or processing; included comments and a known limitation.

Possibly related PRs

  • Custom Columns docs #1219: Adds documentation for custom columns in multiple atmos list commands, which is directly related as this PR removes that documentation.

Suggested labels

no-release

Suggested reviewers

  • milldr

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary or @auto-summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @auto-title anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
tests/fixtures/scenarios/vendor/atmos.yaml (3)

32-35: Clean up commented-out examples
The disabled Description and Folder entries are vestigial and only add noise. Unless they serve a clear purpose for future tests, consider removing them.


36-36: Refine explanatory comment
Switch to a single # and tighten the phrasing for clarity. For example:

# Custom columns are currently unsupported; output always shows the default folder name.

37-37: Remove trailing whitespace
There’s a blank line containing stray spaces—trimming it will clean up the fixture.

🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 37-37: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b6c2077 and 3ce376f.

📒 Files selected for processing (9)
  • tests/fixtures/scenarios/vendor/atmos.yaml (1 hunks)
  • website/docs/cli/commands/list/list-components.mdx (0 hunks)
  • website/docs/cli/commands/list/list-metadata.mdx (0 hunks)
  • website/docs/cli/commands/list/list-settings.mdx (0 hunks)
  • website/docs/cli/commands/list/list-stacks.mdx (0 hunks)
  • website/docs/cli/commands/list/list-values.mdx (0 hunks)
  • website/docs/cli/commands/list/list-vars.mdx (0 hunks)
  • website/docs/cli/commands/list/list-workflows.mdx (0 hunks)
  • website/docs/cli/commands/list/usage.mdx (0 hunks)
💤 Files with no reviewable changes (8)
  • website/docs/cli/commands/list/list-vars.mdx
  • website/docs/cli/commands/list/list-values.mdx
  • website/docs/cli/commands/list/list-components.mdx
  • website/docs/cli/commands/list/list-metadata.mdx
  • website/docs/cli/commands/list/list-settings.mdx
  • website/docs/cli/commands/list/list-stacks.mdx
  • website/docs/cli/commands/list/usage.mdx
  • website/docs/cli/commands/list/list-workflows.mdx
🧰 Additional context used
🪛 YAMLlint (1.37.1)
tests/fixtures/scenarios/vendor/atmos.yaml

[error] 37-37: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Acceptance Tests (macos-latest, macos)
  • GitHub Check: Acceptance Tests (windows-latest, windows)
  • GitHub Check: Acceptance Tests (ubuntu-latest, linux)
  • GitHub Check: Summary
🔇 Additional comments (1)
tests/fixtures/scenarios/vendor/atmos.yaml (1)

22-31: Validate list.columns configuration
The new list.columns block is well-formed, but since custom columns aren’t supported yet (per PR #1262 objectives), confirm that this fixture’s scenario test expects the default behavior (ignoring these entries).

@mergify mergify bot removed the triage Needs triage label May 21, 2025
@osterman
Copy link
Member

osterman commented Jun 1, 2025

Ugh, really? We didn't land support for custom columns? Could have sworn we had this.

@osterman
Copy link
Member

osterman commented Jun 4, 2025

We're going to look into why this isn't working

@osterman osterman closed this Jun 4, 2025
@mergify mergify bot removed the needs-cloudposse Needs Cloud Posse assistance label Jun 4, 2025
@Benbentwo Benbentwo deleted the docs/remove-section-describe-vars branch June 30, 2025 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants