Skip to content
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

Update azure static web app task output variables #340

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kwickramasekara
Copy link

It looks like the Azure Static Web Apps task has an output variable (AZURESTATICWEBAPP_STATIC_WEB_APP_URL) which however is not documented in the docs.

P.S: I know this section might be auto generated, so I don't anticipate this PR being merged. But I wanted to bring this to attention since this can be particularly useful as static web apps generate random URLs for preview environments.

Copy link
Contributor

@kwickramasekara : Thanks for your contribution! The author(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 2097136:

✅ Validation status: passed

File Status Preview URL Details
task-reference/azure-static-web-app-v0.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

@steved0x
Copy link
Contributor

steved0x commented Jun 13, 2024

@kwickramasekara Thank you for submitting this PR. Unfortunately, it would get overwritten the next time the tooling is run, because that part of the article is autogenerated (as you noted in your comment) from the task source code. Here is an example of another task that has an output variable:
https://github.com/microsoft/azure-pipelines-tasks/blob/111fe5c599d29e24d4dc487b0551fd83891a9c56/Tasks/AzureFileCopyV6/task.json#L205

  "outputVariables": [
    {
      "name": "StorageContainerUri",
      "description": "Uri of the container where the files were copied to. Valid only when the selected destination is Azure Blob."
    }

Which surfaces in the docs like this:
https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/azure-file-copy-v6?view=azure-pipelines#output-variables

Let me do some research on this and see if I can get that output variable added to the task metadata for the Static Web App task, and then it will automatically show up in the task documentation. In the meantime, I can add a note in the remarks for that task. I'll keep this PR open until I can make that change.

Update: I have created a PR in the tasks repo to add this variable. When it is merged there, it will automatically reflect in the task article. I will add remarks to emphasize this for Azure DevOps Server 2022 customers, because this change won't get reflected there except in the latest updates.
microsoft/azure-pipelines-tasks#20009

@kwickramasekara
Copy link
Author

@steved0x sounds good, thank you for sharing that info.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants