Skip to content
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.

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

Add support for atlantis version #852

Closed
wants to merge 1 commit into from
Closed

Add support for atlantis version #852

wants to merge 1 commit into from

Conversation

samtholiya
Copy link
Collaborator

@samtholiya samtholiya commented Dec 13, 2024

what

We are adding support for atlantis version

why

We say atmos supports all native atlantis commands, yet we do not support atmos atlantis version

references

issue: https://linear.app/cloudposse/issue/DEV-2839/atmos-atlantis-version-does-not-work

Summary by CodeRabbit

  • New Features

    • Introduced a new command execution functionality for the Atlantis command.
    • Added a wrapper function for executing the Atlantis command with improved argument handling.
  • Bug Fixes

    • Refined logic for handling command-line arguments, particularly for the "version" command.
  • Documentation

    • Updated comments for clarity regarding command-line argument processing.

@samtholiya samtholiya requested review from a team as code owners December 13, 2024 07:46
Copy link
Contributor

coderabbitai bot commented Dec 13, 2024

📝 Walkthrough

Walkthrough

The changes in this pull request introduce a new command execution mechanism for the atlantisCmd in the cmd/atlantis.go file. A new function ExecuteAtlantis is added in the exec package, which processes command line arguments and initializes the CLI configuration. Additionally, the processArgsAndFlags function in utils.go is refined to improve the handling of the NeedHelp flag, specifically for the "version" argument. These modifications enhance the command's execution logic while maintaining the overall structure.

Changes

Files Change Summary
cmd/atlantis.go Added import for exec package; modified atlantisCmd to include a Run function calling exec.ExecuteAtlantis(cmd, args).
internal/exec/atlantis_generate_repo_config.go Introduced ExecuteAtlantis function to process command line arguments and execute shell commands.
internal/exec/utils.go Adjusted processArgsAndFlags to refine handling of NeedHelp flag based on the "version" argument.

Assessment against linked issues

Objective Addressed Explanation
Support atmos atlantis version command (DEV-2839)

Possibly related PRs

Suggested labels

minor

Suggested reviewers

  • osterman
  • aknysh
  • johncblandii
  • mcalhoun

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. (Experiment)
  • @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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 22c9b28 and 137ff34.

📒 Files selected for processing (3)
  • cmd/atlantis.go (2 hunks)
  • internal/exec/atlantis_generate_repo_config.go (1 hunks)
  • internal/exec/utils.go (1 hunks)
🧰 Additional context used
🪛 golangci-lint (1.62.2)
cmd/atlantis.go

15-15: Error return value of exec.ExecuteAtlantis is not checked

(errcheck)

🔇 Additional comments (2)
internal/exec/atlantis_generate_repo_config.go (1)

20-32: Implementation looks solid!

The new ExecuteAtlantis function is well-structured with proper error handling and follows the established patterns in the codebase.

internal/exec/utils.go (1)

664-674: Clean implementation of version command handling!

The changes correctly handle the special case for the version command while maintaining the existing behavior for other single-argument commands.

Comment on lines +14 to +16
Run: func(cmd *cobra.Command, args []string) {
exec.ExecuteAtlantis(cmd, args)
},
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Handle the error returned by ExecuteAtlantis

The error returned by ExecuteAtlantis should be checked and handled appropriately to prevent silent failures.

Apply this diff to handle the error:

Run: func(cmd *cobra.Command, args []string) {
-    exec.ExecuteAtlantis(cmd, args)
+    if err := exec.ExecuteAtlantis(cmd, args); err != nil {
+        fmt.Fprintf(os.Stderr, "Error executing atlantis command: %v\n", err)
+        os.Exit(1)
+    }
},
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Run: func(cmd *cobra.Command, args []string) {
exec.ExecuteAtlantis(cmd, args)
},
Run: func(cmd *cobra.Command, args []string) {
if err := exec.ExecuteAtlantis(cmd, args); err != nil {
fmt.Fprintf(os.Stderr, "Error executing atlantis command: %v\n", err)
os.Exit(1)
}
},
🧰 Tools
🪛 golangci-lint (1.62.2)

15-15: Error return value of exec.ExecuteAtlantis is not checked

(errcheck)

@osterman
Copy link
Member

There's Pull Request makes no sense because we don't support any Atlantis commands today. We do support one command to generate Atlantis configurations, but we never call the Atlantis binary via Atmos. The Atlantis binary is never even needed.

@osterman osterman closed this Dec 13, 2024
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.

2 participants