Merge pull request #29 from samsmithnz/ConsoleOutputUpdates

Experimenting with better console logging

Author: samsmithnz

.devcontainer/devcontainer.json

@@ -13,7 +13,7 @@
 	// "forwardPorts": [],
 
 	// Use 'postCreateCommand' to run commands after the container is created.
-	// "postCreateCommand": "src/deploymentfrequency.ps1 -ownerRepo 'SamSmithnz/SamsFeatureFlags' -workflows 'Feature Flags CI/CD,CodeQL' -branch 'Main' -numberOfDays 30 -patToken $env:PATTOKEN -showVerboseLogging $true",
+	// "postCreateCommand": "src/deploymentfrequency.ps1 -ownerRepo 'SamSmithnz/SamsFeatureFlags' -workflows 'Feature Flags CI/CD,CodeQL' -branch 'Main' -numberOfDays 30 -patToken $env:PATTOKEN",
 
 
 	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.

.github/workflows/workflow.yml

@@ -51,22 +51,19 @@ jobs:
           owner-repo: 'samsmithnz/DevOpsMetrics'
           default-branch: 'main'
           number-of-days: 30
-          show-verbose-logging: 0
       - name: Test no workflow
         uses: ./
         with:
           workflows: ''
           owner-repo: 'samsmithnz/GitHubToAzureDevOps'
-          show-verbose-logging: 0
 
       #authenication tests          
       - name: Test elite repo with PAT Token
         uses: ./
         with:
           workflows: 'Feature Flags CI/CD'
           owner-repo: 'samsmithnz/SamsFeatureFlags'
-          pat-token: "${{ secrets.PATTOKEN }}"    
-          show-verbose-logging: 0      
+          pat-token: "${{ secrets.PATTOKEN }}"      
       - name: Test elite repo, multiple workflows, with PAT Token
         uses: ./
         with:

GitVersion.yml

@@ -1 +1 @@
-next-version: 1.2.0
+next-version: 1.3.0

README.md

@@ -24,7 +24,6 @@ A GitHub Action to roughly calculate DORA deployment frequency. This is not mean
 - `app-id`: optional, string, defaults to '', application id of the registered GitHub app
 - `app-install-id`: optional, string, defaults to '', id of the installed instance of the GitHub app
 - `app-private-key`: optional, string, defaults to '', private key which has been generated for the installed instance of the GitHub app. Must be provided without leading `'-----BEGIN RSA PRIVATE KEY----- '` and trailing `' -----END RSA PRIVATE KEY-----'`.
-- `show-verbose-logging`: optional, bool, defaults to 0, if set to 1, will show more verbose logging information
 
 To test the current repo (same as where the action runs)
 ```

action.yml

@@ -31,16 +31,13 @@ inputs:
   app-private-key:
     description: 'private key which has been generated for the installed instance of the GitHub app'
     default: ""
-  show-verbose-logging:
-    description: 'show more details of the calculation and processing'
-    default: 0 # (0 == false)
 runs:
   using: "composite"
   steps:
     - name: Run DORA deployment frequency 
       shell: pwsh
       run: |
-         $result = ${{ github.action_path }}/src/deploymentfrequency.ps1 -ownerRepo "${{ inputs.owner-repo }}" -workflows "${{ inputs.workflows }}" -branch "${{ inputs.default-branch }}" -numberOfDays ${{ inputs.number-of-days }} -patToken "${{ inputs.pat-token }}" -actionsToken "${{ inputs.actions-token }}" -appId "${{ inputs.app-id }}" -appInstallationId "${{ inputs.app-install-id }}" -appPrivateKey "${{ inputs.app-private-key }}" -showVerboseLogging ${{ inputs.show-verbose-logging }}
+         $result = ${{ github.action_path }}/src/deploymentfrequency.ps1 -ownerRepo "${{ inputs.owner-repo }}" -workflows "${{ inputs.workflows }}" -branch "${{ inputs.default-branch }}" -numberOfDays ${{ inputs.number-of-days }} -patToken "${{ inputs.pat-token }}" -actionsToken "${{ inputs.actions-token }}" -appId "${{ inputs.app-id }}" -appInstallationId "${{ inputs.app-install-id }}" -appPrivateKey "${{ inputs.app-private-key }}"
          Write-Host "::set-output name=result::$result"
          Write-Output $result >> $env:GITHUB_STEP_SUMMARY
                

src/deploymentfrequency.ps1

@@ -8,8 +8,7 @@ Param(
     [string] $actionsToken = "",
     [string] $appId = "",
     [string] $appInstallationId = "",
-    [string] $appPrivateKey = "",
-    [bool] $showVerboseLogging = $false
+    [string] $appPrivateKey = ""
 )
 
 #The main function
@@ -21,8 +20,7 @@ function Main ([string] $ownerRepo,
     [string] $actionsToken = "",
     [string] $appId = "",
     [string] $appInstallationId = "",
-    [string] $appPrivateKey = "",
-    [bool] $showVerboseLogging = $false)
+    [string] $appPrivateKey = "")
 {
 
     #==========================================
@@ -31,19 +29,15 @@ function Main ([string] $ownerRepo,
     $owner = $ownerRepoArray[0]
     $repo = $ownerRepoArray[1]
     $workflowsArray = $workflows -split ','
-    $numberOfDays = $numberOfDays    
-    #Write-Output "showVerboseLogging: $showVerboseLogging"    
-    if ($showVerboseLogging -eq $true)
-    {
-        Write-Output "Owner/Repo: $owner/$repo"
-        Write-Output "Workflows: $workflows"
-        Write-Output "Branch: $branch"
-        Write-Output "Number of days: $numberOfDays"
-    }
+    $numberOfDays = $numberOfDays       
+    Write-Host "Owner/Repo: $owner/$repo"
+    Write-Host "Workflows: $workflows"
+    Write-Host "Branch: $branch"
+    Write-Host "Number of days: $numberOfDays"
 
     #==========================================
     # Get authorization headers  
-    $authHeader = GetAuthHeader $patToken $actionsToken $appId $appInstallationId $appPrivateKey $showVerboseLogging
+    $authHeader = GetAuthHeader $patToken $actionsToken $appId $appInstallationId $appPrivateKey
 
     #==========================================
     #Get workflow definitions from github
@@ -83,10 +77,6 @@ function Main ([string] $ownerRepo,
                     $result = $workflowNames.Add($workflow.name)
                 }
             }
-            # else 
-            # {
-            #     Write-Output "'$($workflow.name)' DID NOT match with $arrayItem"
-            # }
         }
     }
 
@@ -114,7 +104,7 @@ function Main ([string] $ownerRepo,
             #Count workflows that are completed, on the target branch, and were created within the day range we are looking at
             if ($run.head_branch -eq $branch -and $run.created_at -gt (Get-Date).AddDays(-$numberOfDays))
             {
-                #Write-Output "Adding item with status $($run.status), branch $($run.head_branch), created at $($run.created_at), compared to $((Get-Date).AddDays(-$numberOfDays))"
+                #Write-Host "Adding item with status $($run.status), branch $($run.head_branch), created at $($run.created_at), compared to $((Get-Date).AddDays(-$numberOfDays))"
                 $buildTotal++       
                 #get the workflow start and end time            
                 $dateList += New-Object PSObject -Property @{start_datetime=$run.created_at;end_datetime=$run.updated_at}
@@ -133,11 +123,10 @@ function Main ([string] $ownerRepo,
                 $deploymentsPerDay = $dateList.Count / $numberOfDays
             }
             $deploymentsPerDayList += $deploymentsPerDay
-            #Write-Output "Adding to list, workflow id $workflowId deployments per day of $deploymentsPerDay"
+            #Write-Host "Adding to list, workflow id $workflowId deployments per day of $deploymentsPerDay"
         }
     }
 
-    #Write-Output "Total items in list is $($deploymentsPerDayList.Length)"
     $totalDeployments = 0
     Foreach ($deploymentItem in $deploymentsPerDayList){
         $totalDeployments += $deploymentItem
@@ -146,7 +135,7 @@ function Main ([string] $ownerRepo,
     {
         $deploymentsPerDay = $totalDeployments / $deploymentsPerDayList.Length
     }
-    #Write-Output "Total deployments $totalDeployments with a final deployments value of $deploymentsPerDay"
+    #Write-Host "Total deployments $totalDeployments with a final deployments value of $deploymentsPerDay"
 
     #==========================================
     #Show current rate limit
@@ -159,10 +148,7 @@ function Main ([string] $ownerRepo,
     {
         $rateLimitResponse = Invoke-RestMethod -Uri $uri3 -ContentType application/json -Method Get -Headers @{Authorization=($authHeader["Authorization"])} -SkipHttpErrorCheck -StatusCodeVariable "HTTPStatus"
     }    
-    if ($showVerboseLogging -eq $true)
-    {
-        Write-Output "Rate limit consumption: $($rateLimitResponse.rate.used) / $($rateLimitResponse.rate.limit)"
-    }
+    Write-Host "Rate limit consumption: $($rateLimitResponse.rate.used) / $($rateLimitResponse.rate.limit)"    
 
     #==========================================
     #Calculate deployments per day
@@ -242,10 +228,7 @@ function Main ([string] $ownerRepo,
 
     if ($dateList.Count -gt 0 -and $numberOfDays -gt 0)
     {
-        if ($showVerboseLogging -eq $true)
-        {
-            Write-Output "Deployment frequency over last $numberOfDays days, is $displayMetric $displayUnit, with a DORA rating of '$rating'"
-        }
+        Write-Host "Deployment frequency over last $numberOfDays days, is $displayMetric $displayUnit, with a DORA rating of '$rating'"        
         return Format-OutputMarkdown -workflowNames $workflowNames -displayMetric $displayMetric -displayUnit $displayUnit -repo $ownerRepo -branch $branch -numberOfDays $numberOfDays -numberOfUniqueDates $uniqueDates.Length.ToString() -color $color -rating $rating
     }
     else
@@ -257,7 +240,7 @@ function Main ([string] $ownerRepo,
 #Generate the authorization header for the PowerShell call to the GitHub API
 #warning: PowerShell has really wacky return semantics - all output is captured, and returned
 #reference: https://stackoverflow.com/questions/10286164/function-return-value-in-powershell
-function GetAuthHeader ([string] $patToken, [string] $actionsToken, [string] $appId, [string] $appInstallationId, [string] $appPrivateKey, [bool] $showVerboseLogging = $false) 
+function GetAuthHeader ([string] $patToken, [string] $actionsToken, [string] $appId, [string] $appInstallationId, [string] $appPrivateKey) 
 {
     #Clean the string - without this the PAT TOKEN doesn't process
     $patToken = $patToken.Trim()
@@ -267,36 +250,24 @@ function GetAuthHeader ([string] $patToken, [string] $actionsToken, [string] $ap
     #Write-Host "patToken is something: $(![string]::IsNullOrEmpty($patToken))"
     if (![string]::IsNullOrEmpty($patToken))
     {
-        if ($showVerboseLogging -eq $true)
-        {
-            Write-Host "Authentication detected: PAT TOKEN"
-        }
+        Write-Host "Authentication detected: PAT TOKEN"
         $base64AuthInfo = [System.Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes(":$patToken"))
         $authHeader = @{Authorization=("Basic {0}" -f $base64AuthInfo)}
     }
     elseif (![string]::IsNullOrEmpty($actionsToken))
     {
-        if ($showVerboseLogging -eq $true)
-        {
-            Write-Host "Authentication detected: GITHUB TOKEN"  
-        }
+        Write-Host "Authentication detected: GITHUB TOKEN"  
         $authHeader = @{Authorization=("Bearer {0}" -f $base64AuthInfo)}
     }
     elseif (![string]::IsNullOrEmpty($appId)) # GitHup App auth
     {
-        if ($showVerboseLogging -eq $true)
-        {
-            Write-Host "Authentication detected: GITHUB APP TOKEN"  
-        }
+        Write-Host "Authentication detected: GITHUB APP TOKEN"  
         $token = Get-JwtToken $appId $appInstallationId $appPrivateKey        
         $authHeader = @{Authorization=("token {0}" -f $token)}
     }    
     else
     {
-        if ($showVerboseLogging -eq $true)
-        {
-            Write-Host "No authentication detected" 
-        }
+        Write-Host "No authentication detected" 
         $base64AuthInfo = $null
         $authHeader = $null
     }
@@ -367,8 +338,8 @@ function Get-JwtToken([string] $appId, [string] $appInstallationId, [string] $ap
 function Format-OutputMarkdown([array] $workflowNames, [string] $rating, [string] $displayMetric, [string] $displayUnit, [string] $repo, [string] $branch, [string] $numberOfDays, [string] $numberOfUniqueDates, [string] $color)
 {
     $encodedDeploymentFrequency = [uri]::EscapeUriString($displayMetric + " " + $displayUnit)
-
-    $markdown = "![Deployment Frequency](https://img.shields.io/badge/frequency-" + $encodedDeploymentFrequency + "-" + $color + "?logo=github&label=Deployment%20frequency)`r`n" +
+    #double newline to start the line helps with formatting in GitHub logs
+    $markdown = "`n`n![Deployment Frequency](https://img.shields.io/badge/frequency-" + $encodedDeploymentFrequency + "-" + $color + "?logo=github&label=Deployment%20frequency)`n" +
         "**Definition:** For the primary application or service, how often is it successfully deployed to production.`n" +
         "**Results:** Deployment frequency is **$displayMetric $displayUnit** with a **$rating** rating, over the last **$numberOfDays days**.`n" + 
         "**Details**:`n" + 
@@ -381,10 +352,11 @@ function Format-OutputMarkdown([array] $workflowNames, [string] $rating, [string
 
 function Format-NoOutputMarkdown([string] $workflows, [string] $numberOfDays)
 {
-    $markdown = "![Deployment Frequency](https://img.shields.io/badge/frequency-none-lightgrey?logo=github&label=Deployment%20frequency)`r`n`n" +
+    #double newline to start the line helps with formatting in GitHub logs
+    $markdown = "`n`n![Deployment Frequency](https://img.shields.io/badge/frequency-none-lightgrey?logo=github&label=Deployment%20frequency)`n`n" +
         "No data to display for $ownerRepo for workflow(s) $workflows over the last $numberOfDays days`n`n" + 
         "---"
     return $markdown
 }
 
-main -ownerRepo $ownerRepo -workflows $workflows -branch $branch -numberOfDays $numberOfDays -patToken $patToken -actionsToken $actionsToken -appId $appId -appInstallationId $appInstallationId -appPrivateKey $appPrivateKey -showVerboseLogging $showVerboseLogging
+main -ownerRepo $ownerRepo -workflows $workflows -branch $branch -numberOfDays $numberOfDays -patToken $patToken -actionsToken $actionsToken -appId $appId -appInstallationId $appInstallationId -appPrivateKey $appPrivateKey