Skip to content

Comments

Enhance deploy command docs to clarify behavior for RE deployments#1955

Merged
feluelle merged 1 commit intomainfrom
astro-deploy-improve-cmd-description
Oct 9, 2025
Merged

Enhance deploy command docs to clarify behavior for RE deployments#1955
feluelle merged 1 commit intomainfrom
astro-deploy-improve-cmd-description

Conversation

@feluelle
Copy link
Member

@feluelle feluelle commented Oct 9, 2025

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

@feluelle feluelle merged commit 172f551 into main Oct 9, 2025
2 of 5 checks passed
@feluelle feluelle deleted the astro-deploy-improve-cmd-description branch October 9, 2025 14:01
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