Skip to content

[Feature] better guidance in instructions and failed workflow recovery #97

Open
@mstojanovic

Description

@mstojanovic

Summary

AInstructions are unclear in a few points and can be improved to make them more precise and useful

Changes

.github/steps/2-setup-azure-environment.md
Name your new secret AZURE_SUBSCRIPTION_ID and paste the value from the id: field in the first command. ->
Name your new secret AZURE_SUBSCRIPTION_ID and paste the value from the Subscription ID: field in the first command.
or
Name your new secret AZURE_SUBSCRIPTION_ID and paste the value from the subscriptionId: field in the second command.

.github/steps/3-spinup-environment.md
in the .yml code the use of AZURE_REGION: a user could be pointed on where to check available regions for his Azure subscription, the link provided below does not offer that. This was the issue for me and that failed the workflow. Luckily, i do know how to use git and i could recover from it but users that fail. Another problem with this is that the new Step 4 page was created even if the workflow failed.

.github/steps/6-destroy-azure-environment.md
at the end there is a mention of the apps URLm and that was not presented to the user at any point before (or how to obtain it)

Additional context

some of the users of this tutorial will be beginners and the few issues i have encountered might make the users panic or quit. the tutorial is amazing by the way, really well done

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions