Environment URL (#751)

This PR will add the URL of the environment being deployed to underneath
the Environment name in the Build summary, like:

![image](https://github.com/microsoft/AL-Go/assets/10775043/a7abe194-618f-4651-a21f-f761342e6a4a)

It is implemented in the Publish To Environment workflow and for
Continuous Deployment in the CI/CD workflow.

![image](https://github.com/microsoft/AL-Go/assets/10775043/421d4402-b0b1-48af-b393-ce6318351f75)

and also supports custom deployment.

---------

Co-authored-by: freddydk <freddydk@users.noreply.github.com>

Actions/Deploy/Deploy.ps1

@@ -169,8 +169,10 @@ try {
             throw "Authentication failed. $([environment]::Newline) $($_.exception.message)"
         }
 
-        Write-Host "$($bcContainerHelperConfig.baseUrl.TrimEnd('/'))/$($bcAuthContext.tenantId)/$($deploymentSettings.EnvironmentName)/deployment/url"
-        $response = Invoke-RestMethod -UseBasicParsing -Method Get -Uri "$($bcContainerHelperConfig.baseUrl.TrimEnd('/'))/$($bcAuthContext.tenantId)/$($deploymentSettings.EnvironmentName)/deployment/url"
+        $environmentUrl = "$($bcContainerHelperConfig.baseUrl.TrimEnd('/'))/$($bcAuthContext.tenantId)/$($deploymentSettings.EnvironmentName)"
+        Add-Content -Encoding UTF8 -Path $env:GITHUB_OUTPUT -Value "environmentUrl=$environmentUrl"
+        Write-Host "EnvironmentUrl: $environmentUrl"
+        $response = Invoke-RestMethod -UseBasicParsing -Method Get -Uri "$environmentUrl/deployment/url"
         if ($response.Status -eq "DoesNotExist") {
             OutputError -message "Environment with name $($deploymentSettings.EnvironmentName) does not exist in the current authorization context."
             exit

Actions/Deploy/README.md

@@ -22,4 +22,6 @@ Deploy Apps to online environment
 | type | | Type of delivery (CD or Release) | CD |
 
 ## OUTPUT
-none
+| Name | Description |
+| :-- | :-- |
+| environmentUrl | The URL for the environment. This URL is presented in the Deploy Step in summary under the environment name |

Actions/Deploy/action.yaml

@@ -26,11 +26,16 @@ inputs:
   deploymentEnvironmentsJson:
     description: The settings for all Deployment Environments
     required: true
+outputs:
+  environmentUrl:
+    description: The URL of the deployed environment
+    value: ${{ steps.Deploy.outputs.environmentUrl }}
 runs:
   using: composite
   steps:
     - name: run
       shell: ${{ inputs.shell }}
+      id: Deploy
       env:
         _token: ${{ inputs.token }}
         _parentTelemetryScopeJson: ${{ inputs.parentTelemetryScopeJson }}

RELEASENOTES.md

@@ -17,6 +17,8 @@ AL-Go for GitHub allows you to build and test using insider builds without any e
 ### New Settings
 - `enableExternalRulesets`: set this setting to true if you want to allow AL-Go to automatically download external references in rulesets.
 
+### Deployment
+Environment URL is now displayed underneath the environment being deployed to in the build summary. For Custom Deployment, the script can set the GitHub Output variable `environmentUrl` in order to show a custom URL.
 
 ## v3.3
 

Templates/AppSource App/.github/workflows/CICD.yaml

@@ -157,6 +157,7 @@ jobs:
     name: Deploy to ${{ matrix.environment }}
     environment:
       name: ${{ matrix.environment }}
+      url: ${{ steps.Deploy.outputs.environmentUrl }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -187,6 +188,7 @@ jobs:
           getSecrets: '${{ steps.envName.outputs.envName }}-AuthContext,${{ steps.envName.outputs.envName }}_AuthContext,AuthContext,${{ steps.envName.outputs.envName }}-EnvironmentName,${{ steps.envName.outputs.envName }}_EnvironmentName,EnvironmentName,projects'
 
       - name: Deploy
+        id: Deploy
         uses: microsoft/AL-Go-Actions/Deploy@main
         env:
           Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'

Templates/AppSource App/.github/workflows/PublishToEnvironment.yaml

@@ -117,6 +117,7 @@ jobs:
     name: Deploy to ${{ matrix.environment }}
     environment:
       name: ${{ matrix.environment }}
+      url: ${{ steps.Deploy.outputs.environmentUrl }}
     env:
       deviceCode: ${{ needs.Initialization.outputs.deviceCode }}
     steps:
@@ -144,6 +145,7 @@ jobs:
           getSecrets: '${{ steps.envName.outputs.envName }}-AuthContext,${{ steps.envName.outputs.envName }}_AuthContext,AuthContext,${{ steps.envName.outputs.envName }}-EnvironmentName,${{ steps.envName.outputs.envName }}_EnvironmentName,EnvironmentName,projects'
 
       - name: Deploy
+        id: Deploy
         uses: microsoft/AL-Go-Actions/Deploy@main
         env:
           Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'

Templates/Per Tenant Extension/.github/workflows/CICD.yaml

@@ -157,6 +157,7 @@ jobs:
     name: Deploy to ${{ matrix.environment }}
     environment:
       name: ${{ matrix.environment }}
+      url: ${{ steps.Deploy.outputs.environmentUrl }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -187,6 +188,7 @@ jobs:
           getSecrets: '${{ steps.envName.outputs.envName }}-AuthContext,${{ steps.envName.outputs.envName }}_AuthContext,AuthContext,${{ steps.envName.outputs.envName }}-EnvironmentName,${{ steps.envName.outputs.envName }}_EnvironmentName,EnvironmentName,projects'
 
       - name: Deploy
+        id: Deploy
         uses: microsoft/AL-Go-Actions/Deploy@main
         env:
           Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'

Templates/Per Tenant Extension/.github/workflows/PublishToEnvironment.yaml

@@ -117,6 +117,7 @@ jobs:
     name: Deploy to ${{ matrix.environment }}
     environment:
       name: ${{ matrix.environment }}
+      url: ${{ steps.Deploy.outputs.environmentUrl }}
     env:
       deviceCode: ${{ needs.Initialization.outputs.deviceCode }}
     steps:
@@ -144,6 +145,7 @@ jobs:
           getSecrets: '${{ steps.envName.outputs.envName }}-AuthContext,${{ steps.envName.outputs.envName }}_AuthContext,AuthContext,${{ steps.envName.outputs.envName }}-EnvironmentName,${{ steps.envName.outputs.envName }}_EnvironmentName,EnvironmentName,projects'
 
       - name: Deploy
+        id: Deploy
         uses: microsoft/AL-Go-Actions/Deploy@main
         env:
           Secrets: '${{ steps.ReadSecrets.outputs.Secrets }}'

Tests/Deploy.Action.Test.ps1

@@ -20,6 +20,7 @@ Describe "Deploy Action Tests" {
         $permissions = [ordered]@{
         }
         $outputs = [ordered]@{
+            "environmentUrl" = "The URL of the deployed environment"
         }
         YamlTest -scriptRoot $scriptRoot -actionName $actionName -actionScript $actionScript -permissions $permissions -outputs $outputs
     }