astronomer / astro-cli

CLI that makes it easy to create, test and deploy Airflow DAGs to Astronomer
https://www.astronomer.io
Other
334 stars 70 forks source link

Improve message for the missed "workspace" option while using Org level tokens #1635

Open afastronomer opened 2 months ago

afastronomer commented 2 months ago

✍️ Is your feature request related to a problem? Please describe.

Current message is not very clear for customers why CLI failed and what has to be done.

Error: failed to get current Workspace: current workspace context not set, you can switch to a workspace with 
stro workspace switch WORKSPACEID
Run cd ./
/opt/actions-runner/_work/_temp/750566f7-88f2-42d7-87d2-7f9a311b6095.sh: line 13: conditional binary operator expected
.github/workflows/deploy-to-astro.yaml is not a DAG, triggering a full image build
Error: Process completed with exit code 2.

🧩 Describe the solution you'd like

Add something more explicit, e.g.

Probably you use Org level token without specifying a workspace ID.

Or even add a link to Doc page where we describe possible solutions.

🤔 Describe alternatives you've considered

Add an example into README with a workspace option usage and comment about Org level token. Ideally to add feature AND example into README.

Is your feature request specific to a particular Astronomer Platform?