Merge pull request #40 from actions/improve-error-message

Improve error message

dist/index.js

@@ -7142,15 +7142,41 @@ class Deployment {
         })
         this.requestedDeployment = true
         core.info(`Created deployment for ${this.buildVersion}`)
-        core.info(JSON.stringify(response.data))
+        if (response && response.data) {
-        this.deploymentInfo = response.data
+          core.info(JSON.stringify(response.data))
-      } catch (error) {
+          this.deploymentInfo = response.data
-        core.info(`Failed to create deployment for ${this.buildVersion}.`)
+        }
-        if (error.response && error.response.data) {
+      } catch (error) {
-          core.info(JSON.stringify(error.response.data))
+
+        core.info(error.stack)
+
+        // output raw error in debug mode.
+        core.debug(JSON.stringify(error))
+
+        // build customized error message based on server response
+        if (error.response) {
+          let errorMessage = `Failed to create deployment (status: ${error.response.status}) with build version ${this.buildVersion}. `
+          if (error.response.status == 400) {
+            let message = ""
+            if (error.response.data && error.response.data.message) {
+              message = error.response.data.message
+            } else {
+              message = error.response.data
+            }
+            errorMessage += `Responded with: ${message}`
+          }
+          else if (error.response.status == 403) {
+            errorMessage += `Ensure GITHUB_TOKEN has permission "pages: write".`
+          } else if (error.response.status == 404) {
+            errorMessage += `Ensure GitHub Pages has been enabled.`
+          }
+          else if (error.response.status >= 500) {
+            errorMessage += `Server error, is githubstatus.com reporting a Pages outage? Please re-run the deployment at a later time.`
+          }
+          throw errorMessage
+        } else {
+          throw error
         }
-        core.setFailed(error)
-        throw error
       }
     }
 
@@ -7489,14 +7515,21 @@ async function cancelHandler(evtOrExitCodeOrError) {
       core.info(`Deployment cancelled with ${pagesCancelDeployEndpoint}`)
     }
   } catch (e) {
-    console.info('Deployment cancellation failed', e)
+    console.log('Deployment cancellation failed', e)
   }
   process.exit(isNaN(+evtOrExitCodeOrError) ? 1 : +evtOrExitCodeOrError)
 }
 
 async function main() {
+  let idToken = ""
+  try {
+    idToken = await core.getIDToken()
+  } catch (error) {
+    console.log(error)
+    core.setFailed(`Ensure GITHUB_TOKEN has permission "idToken: write".`)
+    return
+  }
   try {
-    const idToken = await core.getIDToken()
     await deployment.create(idToken)
     await deployment.check()
   } catch (error) {

pre/index.js

@@ -7142,15 +7142,41 @@ class Deployment {
         })
         this.requestedDeployment = true
         core.info(`Created deployment for ${this.buildVersion}`)
-        core.info(JSON.stringify(response.data))
+        if (response && response.data) {
-        this.deploymentInfo = response.data
+          core.info(JSON.stringify(response.data))
-      } catch (error) {
+          this.deploymentInfo = response.data
-        core.info(`Failed to create deployment for ${this.buildVersion}.`)
+        }
-        if (error.response && error.response.data) {
+      } catch (error) {
-          core.info(JSON.stringify(error.response.data))
+
+        core.info(error.stack)
+
+        // output raw error in debug mode.
+        core.debug(JSON.stringify(error))
+
+        // build customized error message based on server response
+        if (error.response) {
+          let errorMessage = `Failed to create deployment (status: ${error.response.status}) with build version ${this.buildVersion}. `
+          if (error.response.status == 400) {
+            let message = ""
+            if (error.response.data && error.response.data.message) {
+              message = error.response.data.message
+            } else {
+              message = error.response.data
+            }
+            errorMessage += `Responded with: ${message}`
+          }
+          else if (error.response.status == 403) {
+            errorMessage += `Ensure GITHUB_TOKEN has permission "pages: write".`
+          } else if (error.response.status == 404) {
+            errorMessage += `Ensure GitHub Pages has been enabled.`
+          }
+          else if (error.response.status >= 500) {
+            errorMessage += `Server error, is githubstatus.com reporting a Pages outage? Please re-run the deployment at a later time.`
+          }
+          throw errorMessage
+        } else {
+          throw error
         }
-        core.setFailed(error)
-        throw error
       }
     }
 

src/deployment.js

@@ -62,15 +62,41 @@ class Deployment {
         })
         this.requestedDeployment = true
         core.info(`Created deployment for ${this.buildVersion}`)
-        core.info(JSON.stringify(response.data))
+        if (response && response.data) {
-        this.deploymentInfo = response.data
+          core.info(JSON.stringify(response.data))
-      } catch (error) {
+          this.deploymentInfo = response.data
-        core.info(`Failed to create deployment for ${this.buildVersion}.`)
+        }
-        if (error.response && error.response.data) {
+      } catch (error) {
-          core.info(JSON.stringify(error.response.data))
+
+        core.info(error.stack)
+
+        // output raw error in debug mode.
+        core.debug(JSON.stringify(error))
+
+        // build customized error message based on server response
+        if (error.response) {
+          let errorMessage = `Failed to create deployment (status: ${error.response.status}) with build version ${this.buildVersion}. `
+          if (error.response.status == 400) {
+            let message = ""
+            if (error.response.data && error.response.data.message) {
+              message = error.response.data.message
+            } else {
+              message = error.response.data
+            }
+            errorMessage += `Responded with: ${message}`
+          }
+          else if (error.response.status == 403) {
+            errorMessage += `Ensure GITHUB_TOKEN has permission "pages: write".`
+          } else if (error.response.status == 404) {
+            errorMessage += `Ensure GitHub Pages has been enabled.`
+          }
+          else if (error.response.status >= 500) {
+            errorMessage += `Server error, is githubstatus.com reporting a Pages outage? Please re-run the deployment at a later time.`
+          }
+          throw errorMessage
+        } else {
+          throw error
         }
-        core.setFailed(error)
-        throw error
       }
     }
 

src/index.js

@@ -32,14 +32,21 @@ async function cancelHandler(evtOrExitCodeOrError) {
       core.info(`Deployment cancelled with ${pagesCancelDeployEndpoint}`)
     }
   } catch (e) {
-    console.info('Deployment cancellation failed', e)
+    console.log('Deployment cancellation failed', e)
   }
   process.exit(isNaN(+evtOrExitCodeOrError) ? 1 : +evtOrExitCodeOrError)
 }
 
 async function main() {
+  let idToken = ""
+  try {
+    idToken = await core.getIDToken()
+  } catch (error) {
+    console.log(error)
+    core.setFailed(`Ensure GITHUB_TOKEN has permission "idToken: write".`)
+    return
+  }
   try {
-    const idToken = await core.getIDToken()
     await deployment.create(idToken)
     await deployment.check()
   } catch (error) {