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

Improve error message
run npm generate file
2026-03-28 17:04:53 +00:00 · 2022-06-29 10:37:48 -07:00 · 2022-06-29 10:35:08 -07:00 · 2022-06-29 10:16:32 -07:00 · 2022-06-28 18:18:42 -07:00 · 2022-06-28 18:01:48 -07:00
7 changed files with 123 additions and 30 deletions
--- a/1
+++ b/1
@@ -0,0 +1 @@
+* @actions/pages
--- a/dist/index.js
+++ b/dist/index.js
@@ -7142,17 +7142,43 @@ class Deployment {
        })
        this.requestedDeployment = true
        core.info(`Created deployment for ${this.buildVersion}`)
+        if (response && response.data) {
          core.info(JSON.stringify(response.data))
          this.deploymentInfo = response.data
-      } catch (error) {
-        core.info(`Failed to create deployment for ${this.buildVersion}.`)
-        if (error.response && error.response.data) {
-          core.info(JSON.stringify(error.response.data))
        }
-        core.setFailed(error)
+      } catch (error) {
+
+        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
        }
      }
+    }

    // Poll the deployment endpoint for status
    async check() {
@@ -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) {
--- a/dist/index.js.map
+++ b/dist/index.js.map
--- a/pre/index.js
+++ b/pre/index.js
@@ -7142,17 +7142,43 @@ class Deployment {
        })
        this.requestedDeployment = true
        core.info(`Created deployment for ${this.buildVersion}`)
+        if (response && response.data) {
          core.info(JSON.stringify(response.data))
          this.deploymentInfo = response.data
-      } catch (error) {
-        core.info(`Failed to create deployment for ${this.buildVersion}.`)
-        if (error.response && error.response.data) {
-          core.info(JSON.stringify(error.response.data))
        }
-        core.setFailed(error)
+      } catch (error) {
+
+        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
        }
      }
+    }

    // Poll the deployment endpoint for status
    async check() {
--- a/pre/index.js.map
+++ b/pre/index.js.map
--- a/src/deployment.js
+++ b/src/deployment.js
@@ -62,17 +62,43 @@ class Deployment {
        })
        this.requestedDeployment = true
        core.info(`Created deployment for ${this.buildVersion}`)
+        if (response && response.data) {
          core.info(JSON.stringify(response.data))
          this.deploymentInfo = response.data
-      } catch (error) {
-        core.info(`Failed to create deployment for ${this.buildVersion}.`)
-        if (error.response && error.response.data) {
-          core.info(JSON.stringify(error.response.data))
        }
-        core.setFailed(error)
+      } catch (error) {
+
+        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
        }
      }
+    }

    // Poll the deployment endpoint for status
    async check() {
--- a/src/index.js
+++ b/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) {
Author	SHA1	Message	Date
Mingzi	41f0a8ab89	Merge pull request #40 from actions/improve-error-message Improve error message	2022-06-29 10:37:48 -07:00
yimysty	b918908973	run npm generate file	2022-06-29 10:35:08 -07:00
Mingzi	1ae5d2452b	Update src/deployment.js Co-authored-by: Yoann Chaudet <yoannchaudet@github.com>	2022-06-29 10:16:32 -07:00
yimysty	e2219a89b1	fix broken test cases	2022-06-28 18:18:42 -07:00
yimysty	72b116b825	fix unintended changes	2022-06-28 18:01:48 -07:00
yimysty	11a13019c2	adjust debugging message	2022-06-28 17:58:10 -07:00
yimysty	801d74db09	switch to console.log	2022-06-28 17:55:21 -07:00
yimysty	64c69a5fdf	normalize error message	2022-06-28 17:50:08 -07:00
yimysty	03d70e4a19	info stack trace	2022-06-28 17:44:21 -07:00
yimysty	64e33b2a0d	info stack trace	2022-06-28 17:39:10 -07:00
yimysty	c3d24faf75	info stack trace	2022-06-28 17:38:14 -07:00
yimysty	2b0c6eaf67	try output stacktrace as well	2022-06-28 17:35:03 -07:00
yimysty	358b034ef8	improve error message	2022-06-28 16:08:07 -07:00
Yoann Chaudet	13ef0cb0a0	Merge pull request #39 from actions/joshmgross/add-codeowners Add CODEOWNERS	2022-06-14 13:30:16 -07:00
Josh Gross	2bf05927ae	Add CODEOWNERS	2022-06-14 14:39:58 -04:00