Build Version Dashboard

Introduction

ADO Build version dashbaord extension is mainly created to manage the ADO pipeline for all the projects and environemntes in single page. this widget helps to view the latest artifact version (build version) for each environnment.

Prerequisite

ADO Variable Group

1. Create one variable group with any name and created variable group used to store the project specific latest artifact version for each environemnt
2. Add manually the project specific parameters in the below format and the value should be empty

Format of the Parameter Name: {{Env Name}}__{{Project Name}} Example: Dev__SampleProject Test__SampleProject Prod__SampleProject

3. The each project variables value will be updated from deploy pipeline, for that we need to add the below power shell script task into each pipeline

Deploy Pipeline Task

The below task used to update the deployment details to the specific projectand buildVersion variable groups from deploy pipeline

 
      parameters:
        - name: ProjectName
          type: string

        - name: StageName
          type: string

        - name: ArtifactName
          type: string

        - name: taskName
          type: string
          default: ''

        - name: variableGroupIdForArtifact
          type: string
          default: ''


      steps:
        - task: PowerShell@2
          name: VariableGroupUpdate${{parameters.taskName}}
          displayName: 'Update Build Version into Variable Group'
          inputs:
            targetType: 'inline'
            script: |
                    $allvgId = ${{parameters.variableGroupIdForArtifact}}
                    $vg_key = "${{ parameters.StageName }}__${{ parameters.ProjectName }}_#"+$(System.DefinitionId)
                    $dateTime = Get-Date -Format "yyyy-MM-dd-hh-mm-ss"
                    $vg_value = "${{parameters.ArtifactName}}__$dateTime"
                    Write-Host $vg_key
                    Write-Host $vg_value
                    $url = "$($env:SYSTEM_TEAMFOUNDATIONCOLLECTIONURI)$env:SYSTEM_TEAMPROJECTID/_apis/distributedtask/variablegroups/"+$allvgId+"?api-version=6.0-preview.1"
                    Write-Host $url
                    $header = @{
                      "Authorization" = "Bearer $(System.AccessToken)"
                    }
                    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

                    $def = Invoke-RestMethod -Uri $url -Headers $header

                    $def.variables.$vg_key.value = $vg_value
                    $body = @($def) | ConvertTo-Json -Depth 100 -Compress
                    $def = Invoke-RestMethod -Method 'Put' -Uri $url -ContentType 'application/json' -Headers $header -Body $body


            errorActionPreference: 'continue'

Widget config to Dashboard

install the extension to your organization. then the extension will be listed in the dashboard creation page. Once the extension is selected, it shows the configuration options as below,

1. Size - Select the size of the widget that is listed

2. Variable Group API URL - Variable Group API URL for Rest API configuration

3. PAT Token - Is for Rest API to fetch variable group values. The PAT token should have read permission for variable group

Build vershion dashboard Widget