8000 Custom Commands Should Not Require Stacks by samtholiya · Pull Request #1052 · cloudposse/atmos · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Custom Commands Should Not Require Stacks #1052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Feb 12, 2025
Merged

Custom Commands Should Not Require Stacks #1052

merged 2 commits into from
Feb 12, 2025

Conversation

samtholiya
Copy link
Collaborator
@samtholiya samtholiya commented Feb 11, 2025 •
edited
Loading

what

  • We should not require custom commands to have stacks.base_path and stacks.included_paths in atmos config. So this pr will make them optional.

why

  • Custom commands may or may not be using components and stacks data.

references

Summary by CodeRabbit

  • Refactor
    • Streamlined configuration management by removing outdated settings.
    • Improved the system’s validation process for handling configuration parameters.
    • Maintained full support for custom CLI commands for routine operations.

@mergify mergify bot added the triage Needs triage label Feb 11, 2025
samtholiya
samtholiya commented Feb 11, 2025
View reviewed changes
@samtholiya samtholiya added the bug 🐛 An issue with the system label Feb 11, 2025
@osterman
Copy link
Member

I think we want to support stacks, but that stacks are optional, does that make sense? If they are there, great. They are not, then it's not a problem.

@samtholiya samtholiya marked this pull request as ready for review February 11, 2025 23:00
@samtholiya samtholiya requested a review from a team as a code owner February 11, 2025 23:00
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Feb 11, 2025
📝 Walkthrough

Walkthrough

This pull request removes the components, stacks, and logs sections from the atmos.yaml file, ensuring custom commands operate independently of stack validations. In addition, the signature of the checkConfig function in both pkg/config/config.go and pkg/config/utils.go has been updated to include a boolean parameter that controls the execution of stack-related validation. These changes aim to decouple custom command functionality from stack configuration requirements.

Changes

File(s) Change Summary
examples/.../atmos.yaml Removed components, stacks, and logs sections; retained the commands section with custom CLI command definitions.
pkg/config/config.go, pkg/config/utils.go Updated checkConfig function signatures to accept an additional boolean parameter (processStacks/isProcessStack) for conditional stack validation.

Sequence Diagram(s)

sequenceDiagram
    participant CLI as CLI
    participant Init as InitCliConfig
    participant Check as checkConfig
    CLI->>Init: Call InitCliConfig(atmosConfig)
    Init->>Check: Invoke checkConfig(atmosConfig, processStacks)
    alt processStacks true
        Check->>Check: Validate stack parameters (base path, included paths)
    else processStacks false
        Check->>Check: Skip stack validation
    end
    Check-->>Init: Return error or nil
    Init-->>CLI: Return configuration result
Loading

Assessment against linked issues

Objective (DEV-3041) Addressed Explanation
Custom Commands should be independent from stack validations (no requirement for stacks.base_path and stacks.included_paths) ✅

Possibly related PRs

Suggested labels

minor

Suggested reviewers

  • aknysh
  • osterman
  • mcalhoun
📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f10f64c and 5f9cb52.

📒 Files selected for processing (3)
  • examples/demo-custom-command/atmos.yaml (0 hunks)
  • pkg/config/config.go (1 hunks)
  • pkg/config/utils.go (1 hunks)
💤 Files with no reviewable changes (1)
  • examples/demo-custom-command/atmos.yaml
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Summary
🔇 Additional comments (2)
pkg/config/config.go (1)

290-290: LGTM! The change aligns with making stack validation optional.

The addition of the processStacks parameter to the checkConfig function call enables conditional stack validation, which supports the goal of making stack requirements optional for custom commands.

pkg/config/utils.go (1)

394-401: LGTM! Clean implementation of conditional stack validation.

The changes effectively make stack validation optional by:

  1. Adding the isProcessStack parameter to control validation
  2. Wrapping stack-related checks in conditional blocks
  3. Maintaining clear error messages

This implementation aligns perfectly with the goal of making stack requirements optional for custom commands.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

@samtholiya
Copy link
Collaborator Author

I think we want to support stacks, but that stacks are optional, does that make sense? If they are there, great. They are not, then it's not a problem.

That is correct. This pr takes care of this condition.

@mergify mergify bot removed the triage Needs triage label Feb 11, 2025
@osterman osterman changed the title fix custom commands should not need stacks Custom Commands Should Not Require Stacks Feb 12, 2025
@osterman osterman added the patch A minor, backward compatible change label Feb 12, 2025
@aknysh aknysh added minor New features that do not break anything and removed bug 🐛 An issue with the system patch A minor, backward compatible change labels Feb 12, 2025
aknysh
aknysh approved these changes Feb 12, 2025
View reviewed changes
Copy link
Member
@aknysh aknysh left a comment

Choose a reason for hiding this comment

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

thanks @samtholiya

@aknysh aknysh merged commit 28781ce into main Feb 12, 2025
46 checks passed
@aknysh aknysh deleted the feature/dev-3041-bug-fix-custom-commands-require-stacksbase_path-and branch February 12, 2025 19:28
@github-actions GitHub Actions
Copy link

These changes were released in v1.161.0.

@coderabbitai coderabbitai bot mentioned this pull request Mar 15, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@osterman osterman osterman approved these changes

@aknysh aknysh aknysh approved these changes

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees
No one assigned
Labels
minor New features that do not break anything
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@samtholiya @osterman @aknysh
0