Merge pull request #79 from actions/add-settings-url-to-error

Add repo settings URL to help users react to error message

.github/workflows/check-dist.yml

@@ -21,10 +21,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set Node.js 16.x
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: 16.x
 

.github/workflows/test.yml

@@ -10,10 +10,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set Node.JS
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 16.x
 

dist/index.js

@@ -6908,8 +6908,9 @@ function getRequiredVars() {
     buildActor: process.env.GITHUB_ACTOR,
     actionsId: process.env.GITHUB_ACTION,
     githubToken: core.getInput('token'),
-    githubApiUrl: process.env.GITHUB_API_CUSTOM_URL ?? process.env.GITHUB_API_URL ?? 'https://api.github.com',
-    artifactName: core.getInput('artifact_name') ?? 'github-pages',
+    githubApiUrl: process.env.GITHUB_API_URL ?? 'https://api.github.com',
+    githubServerUrl: process.env.GITHUB_SERVER_URL ?? 'https://github.com',
+    artifactName: core.getInput('artifact_name') || 'github-pages',
     isPreview: core.getInput('preview') === 'true'
   }
 }
@@ -6957,6 +6958,7 @@ class Deployment {
     this.requestedDeployment = false
     this.deploymentInfo = null
     this.githubApiUrl = context.githubApiUrl
+    this.githubServerUrl = context.githubServerUrl
     this.artifactName = context.artifactName
     this.isPreview = context.isPreview === true
   }
@@ -6994,14 +6996,11 @@ class Deployment {
         payload.preview = true
       }
       core.info(`Creating deployment with payload:\n${JSON.stringify(payload, null, '\t')}`)
-      core.info(`Sending payload to: ${pagesDeployEndpoint}`)
-      core.info(`It should be sent do: ${process.env.GITHUB_API_CUSTOM_URL}`)
       const response = await axios.post(pagesDeployEndpoint, payload, {
         headers: {
           Accept: 'application/vnd.github.v3+json',
           Authorization: `Bearer ${this.githubToken}`,
-          'Content-type': 'application/json',
-          Host: 'api.github.com'
+          'Content-type': 'application/json'
         }
       })
       this.requestedDeployment = true
@@ -7030,7 +7029,8 @@ class Deployment {
         } 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.`
+          const pagesSettingsUrl = `${this.githubServerUrl}/${this.repositoryNwo}/settings/pages`
+          errorMessage += `Ensure GitHub Pages has been enabled: ${pagesSettingsUrl}`
         } 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.`
         }

package-lock.json

@@ -4767,9 +4767,9 @@
       }
     },
     "node_modules/minimatch": {
-      "version": "3.0.4",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
-      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
       "dev": true,
       "dependencies": {
         "brace-expansion": "^1.1.7"
@@ -9694,9 +9694,9 @@
       "dev": true
     },
     "minimatch": {
-      "version": "3.0.4",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
-      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+      "version": "3.1.2",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
+      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
       "dev": true,
       "requires": {
         "brace-expansion": "^1.1.7"

src/context.js

@@ -11,8 +11,9 @@ function getRequiredVars() {
     buildActor: process.env.GITHUB_ACTOR,
     actionsId: process.env.GITHUB_ACTION,
     githubToken: core.getInput('token'),
-    githubApiUrl: process.env.GITHUB_API_CUSTOM_URL ?? process.env.GITHUB_API_URL ?? 'https://api.github.com',
-    artifactName: core.getInput('artifact_name') ?? 'github-pages',
+    githubApiUrl: process.env.GITHUB_API_URL ?? 'https://api.github.com',
+    githubServerUrl: process.env.GITHUB_SERVER_URL ?? 'https://github.com',
+    artifactName: core.getInput('artifact_name') || 'github-pages',
     isPreview: core.getInput('preview') === 'true'
   }
 }

src/deployment.js

@@ -24,6 +24,7 @@ class Deployment {
     this.requestedDeployment = false
     this.deploymentInfo = null
     this.githubApiUrl = context.githubApiUrl
+    this.githubServerUrl = context.githubServerUrl
     this.artifactName = context.artifactName
     this.isPreview = context.isPreview === true
   }
@@ -61,14 +62,11 @@ class Deployment {
         payload.preview = true
       }
       core.info(`Creating deployment with payload:\n${JSON.stringify(payload, null, '\t')}`)
-      core.info(`Sending payload to: ${pagesDeployEndpoint}`)
-      core.info(`It should be sent do: ${process.env.GITHUB_API_CUSTOM_URL}`)
       const response = await axios.post(pagesDeployEndpoint, payload, {
         headers: {
           Accept: 'application/vnd.github.v3+json',
           Authorization: `Bearer ${this.githubToken}`,
-          'Content-type': 'application/json',
-          Host: 'api.github.com'
+          'Content-type': 'application/json'
         }
       })
       this.requestedDeployment = true
@@ -97,7 +95,8 @@ class Deployment {
         } 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.`
+          const pagesSettingsUrl = `${this.githubServerUrl}/${this.repositoryNwo}/settings/pages`
+          errorMessage += `Ensure GitHub Pages has been enabled: ${pagesSettingsUrl}`
         } 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.`
         }