Give better error message if GitHub CLI or GIT isn't installed (#898)

Fixes #870 --------- Co-authored-by: freddydk <freddydk@users.noreply.github.com>
microsoft · Jan 26, 2024 · 5000d6c · 5000d6c
1 parent 2fe598c
commit 5000d6c
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 7 deletions.
diff --git a/Actions/AL-Go-Helper.ps1 b/Actions/AL-Go-Helper.ps1
@@ -2261,7 +2261,7 @@ function RetryCommand {
         catch {
             $retryCount++
             if ($retryCount -eq $MaxRetries) {
-                throw $_
+                throw
             }
             else {
                 Write-Host "Retrying after $RetryDelaySeconds seconds..."

diff --git a/Actions/BuildReferenceDocumentation/BuildReferenceDocumentation.HelperFunctions.ps1 b/Actions/BuildReferenceDocumentation/BuildReferenceDocumentation.HelperFunctions.ps1
@@ -24,7 +24,7 @@
             & /usr/bin/env sudo pwsh -command "& chmod +x $ENV:aldocPath"
         }
         Write-Host "Installing/Updating docfx"
-        CmdDo -command dotnet -arguments @("tool","update","-g docfx")
+        CmdDo -command dotnet -arguments @("tool","update","-g docfx") -messageIfCmdNotFound "dotnet not found. Please install it from https://dotnet.microsoft.com/download"
     }
     return $ENV:aldocPath
 }

diff --git a/Actions/Github-Helper.psm1 b/Actions/Github-Helper.psm1
@@ -237,7 +237,8 @@ function CmdDo {
         [string] $arguments = "",
         [switch] $silent,
         [switch] $returnValue,
-        [string] $inputStr = ""
+        [string] $inputStr = "",
+        [string] $messageIfCmdNotFound = ""
     )
 
     $oldNoColor = "$env:NO_COLOR"
@@ -282,14 +283,27 @@ function CmdDo {
                 Write-Host $message
             }
             if ($returnValue) {
-                $message.Replace("`r","").Split("`n")
+                $message.Replace("`r", "").Split("`n")
             }
         }
         else {
-            $message += "`n`nExitCode: "+$p.ExitCode + "`nCommandline: $command $arguments"
+            $message += "`n`nExitCode: " + $p.ExitCode + "`nCommandline: $command $arguments"
             throw $message
         }
     }
+    catch [System.ComponentModel.Win32Exception] {
+        if ($_.Exception.NativeErrorCode -eq 2) {
+            if ($messageIfCmdNotFound) {
+                throw $messageIfCmdNotFound
+            }
+            else {
+                throw "Command $command not found, you might need to install that command."
+            }
+        }
+        else {
+            throw
+        }
+    }
     finally {
         try { [Console]::OutputEncoding = $oldEncoding } catch {}
         $env:NO_COLOR = $oldNoColor
@@ -319,7 +333,7 @@ function invoke-gh {
                 $arguments += "$parameter "
             }
         }
-        cmdDo -command gh -arguments $arguments -silent:$silent -returnValue:$returnValue -inputStr $inputStr
+        cmdDo -command gh -arguments $arguments -silent:$silent -returnValue:$returnValue -inputStr $inputStr -messageIfCmdNotFound "Github CLI not found. Please install it from https://cli.github.com/"
     }
 }
 
@@ -343,7 +357,7 @@ function invoke-git {
                 $arguments += "$parameter "
             }
         }
-        cmdDo -command git -arguments $arguments -silent:$silent -returnValue:$returnValue -inputStr $inputStr
+        cmdDo -command git -arguments $arguments -silent:$silent -returnValue:$returnValue -inputStr $inputStr -messageIfCmdNotFound "Git not found. Please install it from https://git-scm.com/downloads"
     }
 }
 

diff --git a/RELEASENOTES.md b/RELEASENOTES.md
@@ -7,6 +7,7 @@ Note that when using the preview version of AL-Go for GitHub, we recommend you U
 
 ### Issues
 - Support release branches that start with releases/
+- Issue 870 Improve Error Handling when CLI is missing
 
 ### Build modes 
 AL-Go ships with Default, Translated and Clean mode out of the box. Now you can also define custom build modes in addition to the ones shipped with AL-Go. This allows you to define your own build modes, which can be used to build your apps in different ways. By default, a custom build mode will build the apps similarly to the Default mode but this behavior can be overridden in e.g. script overrides in your repository.