Refactor GitHub status context naming to include environment and stage name for improved clarity

Author: sathiya-nhs

azure/components/update-github-status.yml

@@ -39,18 +39,22 @@ steps:
 
       BUILD_RESULTS_URL="$(System.CollectionUri)$(System.TeamProject)/_build/results?buildId=$(Build.BuildId)&view=results"
 
+
       if [[ "$(NOTIFY_COMMIT_SHA)" =~ ^[0-9a-f]+$ ]]; then
-        context_suffix="[${environment}]"
-        if [[ -n "${stage_name}" ]]; then
-          context_suffix="[${environment}][${stage_name}]"
+        if [[ -n "${environment}" && -n "${stage_name}" ]]; then
+          context_name="$(Build.DefinitionName)[${environment}][${stage_name}]"
+        elif [[ -n "${environment}" ]]; then
+          context_name="$(Build.DefinitionName)[${environment}]"
+        else
+          context_name="$(Build.DefinitionName)"
         fi
 
         echo "Reporting state ${{ parameters.state }} to ${NOTIFY_GITHUB_REPOSITORY}"
         echo "##[debug] Hitting https://api.github.com/repos/${NOTIFY_GITHUB_REPOSITORY}/statuses/$(NOTIFY_COMMIT_SHA)"
 
         payload=$(jq -nc \
           --arg state "${{ parameters.state }}" \
-          --arg context "$(Build.DefinitionName)${context_suffix}" \
+          --arg context "$context_name" \
           --arg description "${description}" \
           --arg target_url "${BUILD_RESULTS_URL}" \
           '{state: $state, context: $context, description: $description, target_url: $target_url}')