-
Notifications
You must be signed in to change notification settings - Fork 197
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding [azd show] command #2893
Conversation
I'd put |
@vhvb1989 Please see final UX below. cc: @gkulin who helped with the copy and UX. @savannahostrowski DefaultApp not deployed@gkulin I just noticed above that Victor posted a version of this use case with the services and environments shown. I didn't think that was possible. Should we adjust this one? Azure.yaml not detected (files present)No files detected |
Yes, we can adjust to reflect the behavior Victor posted. I think we could probably change the copy at the top of this design:
to remove the word "deployed" so it can be used if the app has been provisioned but regardless of if it's been deployed. So, the cases would be:
|
@gkulin How is this? Azure.yaml present but not provisioned or deployed |
looks good @Austinauth ! @vhvb1989 can you update the ux based on Austin's designs? Let us know if you have any questions! |
@gkulin @Austinauth , I've updated the PR description with all the cases the design. LMK if you like it and if you want to approve the PR Note: |
Looks great Victor, thank you! @gkulin all good on your end? |
thanks Victor! Just a couple things:
|
@gkulin @savannahostrowski @Austinauth . output updated. Showing services first and updated header note based on provisioned v/s not-provisoned |
@gkulin @Austinauth @savannahostrowski Wondering about a few minor points:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Left minor comments but overall looks good!
wrong Grace @weikanglim!
I think it's just supposed to mean we are showing the endpoints / envs for whatever template / app is in the current directory. Are you asking because it's plural? If so, I think we could probably change the line to
do you have an example of it showing only one endpoint when there should be multiple? This is what the output currently looks like for an app with endpoints for api & web:
Good point! I'm actually not sure what the current logic for adding the "Remote" tag here is. Maybe @vhvb1989 can clarify? But when Austin and I were going over that part of the design, I was worried about things getting too cluttered if we listed local/remote for every env (like how |
I forgot to mention in my previous comment: We have this really dark blue that is hard to read in the output(I'm using command prompt w/ the default dark theme) I looked at the output from I talked with @Austinauth and he says it seems to be a problem with the color variables |
@gkulin From what I can tell this issue is probably a result of the ANSI color variables not being assigned correctly. @vhvb1989 are you able to confirm this? The purple text (App name) should be: Bright Magenta |
@weikanglim . It took me a while to understand the concept of remote or not remote env :D One use:
Azd will list A, B and C as |
Colors updated. I was not using the bright blue/magenta. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a few comments around our endpoint listing otherwise looks good.
Azure Dev CLI Install InstructionsInstall scriptsMacOS/Linux
bash:
pwsh:
WindowsPowerShell install
MSI install
Standalone Binary
MSIContainer
Documentationlearn.microsoft.com documentationtitle: Azure Developer CLI reference
|
fix: #1887
Third - iteration for
azd show
command.-> Command is displayed within the
Monitor, test and release your app
section fromazd help
:-> Case A: No
azure.yaml
azd follows the same as all other commands:
azure.yaml
but there's not.azure
folder ( or there is an empty.azure
folder)This case can result after cloning a repo w/o running
azd init
Azd will show the service list, but comment about no environment exists:
If there are not remote-environments, azd will display the same output from case B.
If there are remote environments, azd will list all of them with the remote tag:
-> Case C: Combination of local environments and remote existing environments.
For example, after previous case B.1, the user runs
azd env select local
to pull the remote env to his local filesThen, azd removes the remote tag and adds the current tag:
-> Case D: No services defined on azure.yaml
But there are environments (any of the caseses C or B)
-> Case D.1: No services defined and no environments:
-> Case E: application is not neither provisioned or deployed. For example, right after
azd init
Output displays no endpoints for services
All environments are listed
A message about the app is not provisioned is displayed instead of the link to Azure portal:
-> Case F: After provisioning (with or without deploying)
Azd show the service endpoints
The link to azure portal is displayed
-> Case F.1: Variation from caseF, where template has not services but still deploys infrastructure (like a resource group + an storage account):
Azd can show the azure portal link to the resource group, but there is a message about no services found:
-> Case G: Using
-e
flag likeazd show -e foo
Switch from default-environment to the one requested with flag
-> Case G.1: Using
-e
with not existing environment-> Case H: No changes for
azd show -o json
(backwards compatibility)