Enhance deploy command docs to clarify behavior for RE deployments by feluelle · Pull Request #1955 · astronomer/astro-cli

Description

Describe the purpose of this pull request.

This pull request updates the help text for the deploy command to clarify its behavior when Remote Execution is enabled. The new description explains that, in such cases, only certain components are updated, and users should use a different command for other components.

  • Command documentation update:
    • Updated the Long description in cmd/cloud/deploy.go to clarify that when Remote Execution is enabled, deploy only updates the Orchestration Plane components (API Server and Scheduler), and instructs users to use astro remote deploy for all other components.

🎟 Issue(s)

Related #XXX

🧪 Functional Testing

List the functional testing steps to confirm this feature or fix.

📸 Screenshots

Add screenshots to illustrate the validity of these changes.

📋 Checklist

  • Rebased from the main (or release if patching) branch (before testing)
  • Ran make test before taking out of draft
  • Ran make lint before taking out of draft
  • Added/updated applicable tests
  • Tested against Astro-API (if necessary).
  • Tested against Houston-API and Astronomer (if necessary).
  • Communicated to/tagged owners of respective clients potentially impacted by these changes.
  • Updated any related documentation