Azure / azure-dev

A developer CLI that reduces the time it takes for you to get started on Azure. The Azure Developer CLI (azd) provides a set of developer-friendly commands that map to key stages in your workflow - code, build, deploy, monitor, repeat.
https://aka.ms/azd
MIT License
410 stars 198 forks source link

"Deployment Failed" error needs needs usability improvements #1580

Open Austinauth opened 1 year ago

Austinauth commented 1 year ago

While attempting to deploy a template I encountered a "Deployment failed" error. The error itself was not out of place, however the styling and usability need to be adjusted.

As-is

image

To-be

image

This uses the basic pattern for any sub-step failure.

Ideally we could have a better and more actionable failure message like:

A key vault with the name already exists in a deleted state. Try again with a new key vault name. If you want to use the existing name, you will need to either recover it by doing x or purge the name by doing y.

However, since we don't control the 1000s of different error messages that come from our resource providers, rewriting every message to be more descriptive doesn't scale.

Feedback welcomed.

cc: @rajeshkamal5050 for sizing & prioritization. @savannahostrowski

rajeshkamal5050 commented 1 year ago

Not a minor UX improvement item. Requires more effort in having a good design for our error handling story. Since we deal with so many products and services. Moving it to Backlog.

@savannahostrowski @ellismg

savannahostrowski commented 1 year ago

This is a Gallium item. We planned to address error messages as they came up.

rajeshkamal5050 commented 1 year ago

@ellismg @savannahostrowski adding it to the Germanium bucket. We can pull it into iterations/sprints as part of planning.

rajeshkamal5050 commented 1 year ago

@vhvb1989 can you see the initial error guidance provided by Austin and capture the remaining deltas?

vhvb1989 commented 1 year ago

This is a little complicated change.

azd gets all the deployment-errors until the end. There could be more than one resource with deployment error.

rajeshkamal5050 commented 8 months ago

Assuming the current UX is fine with the way we report deployment failures. Haven't heard much feedback around this to be changed. Moving it to backlog.