Merge atmos specific and terraform help documentation by samtholiya · Pull Request #857 · cloudposse/atmos

samtholiya · 2024-12-14T16:10:47Z

what

Current:

After this change :

Merge help for terraform and atmos
Updated tab mechanism
Fade out not supported commands

why

We want to help customers show both native terraform commands and atmos terraform commands

references

https://linear.app/cloudposse/issue/DEV-2821/atmos-terraform-help-should-also-show-terraform-help

Summary by CodeRabbit

New Features
- Enhanced help command output with a styled logo for the "atmos" command.
- Improved error handling and user feedback for the terraform command.
- Introduced a comprehensive set of Terraform commands with detailed descriptions and examples.
- Dynamic generation of help documentation based on command properties.
- Enhanced command formatting capabilities to indicate unsupported commands.
- Updated version of the Atmos CLI in the GitHub Actions workflow.
Bug Fixes
- Simplified help output for "terraform" commands to reduce clutter.
- Removed automatic update checks from help command execution.
Documentation
- Updated command descriptions for clarity and detail.
- Updated the version of the Atmos CLI in the Dockerfile.
Refactor
- Improved command formatting and usage templates for better representation of command availability.
- Streamlined control flow during help command execution.
- Updated dependency versions in the project.

issue: https://linear.app/cloudposse/issue/DEV-2821/atmos-terraform-help-should-also-show-terraform-help

osterman · 2024-12-15T01:38:16Z

I wonder why your terminal is not in color

osterman · 2024-12-15T13:42:08Z

Oh, I see now I didn't realize we were not using cobra's built-in mechanism.

Can you check why we are not using that because that means we have a very different implementation for this one off command!

I like what you're doing more than what we had. However, it looks nothing like atmos --help

…-also-show-terraform-help

osterman · 2024-12-16T21:19:35Z

Is the current wrapping okay? (i don't think so but because the ticket mentions we want a simple solution)

We have solved the wrapping issues in Cobra, so if we can get the menu back in there, that would be ideal.

cmd/terraform_native_commands.go

internal/exec/help.go

mergify · 2024-12-18T21:31:24Z

💥 This pull request now has conflicts. Could you fix it @samtholiya? 🙏

mergify · 2025-01-07T15:59:04Z

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.

github-actions · 2025-01-07T16:56:49Z

These changes were released in v1.137.0.

Merge atmos specific and terraform help documentation

f0b7b98

issue: https://linear.app/cloudposse/issue/DEV-2821/atmos-terraform-help-should-also-show-terraform-help

Merge branch 'main' into feature/dev-2821-atmos-terraform-help-should…

922ba49

…-also-show-terraform-help

mergify bot added the triage Needs triage label Dec 17, 2024

samtholiya force-pushed the feature/dev-2821-atmos-terraform-help-should-also-show-terraform-help branch from 0fe021a to 4379eda Compare December 17, 2024 20:38

osterman removed the triage Needs triage label Dec 18, 2024

mergify bot added the triage Needs triage label Dec 18, 2024