Migrate from actionsgithub script to own scripts staging deploy (#23184)

* migrate from actions/github-script to own scripts (staging deploy)

* make it executable

* remove need to --no-save install 'esm'

* don't use self-hosted runner so we get latest OS (2.285.0)

* remove pointless try/catch

Author: Peter Bengtsson

.github/actions-scripts/staging-deploy.js

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+
+import parsePrUrl from '../../script/deployment/parse-pr-url.js'
+import getOctokit from '../../script/helpers/github.js'
+import deployToStaging from '../../script/deployment/deploy-to-staging.js'
+
+const { GITHUB_TOKEN, HEROKU_API_TOKEN } = process.env
+
+// Exit if GitHub Actions PAT is not found
+if (!GITHUB_TOKEN) {
+  throw new Error('You must supply a GITHUB_TOKEN environment variable!')
+}
+
+// Exit if Heroku API token is not found
+if (!HEROKU_API_TOKEN) {
+  throw new Error('You must supply a HEROKU_API_TOKEN environment variable!')
+}
+
+// This helper uses the `GITHUB_TOKEN` implicitly!
+// We're using our usual version of Octokit vs. the provided `github`
+// instance to avoid versioning discrepancies.
+const octokit = getOctokit()
+
+const { PR_URL, SOURCE_BLOB_URL, CONTEXT_NAME, ACTIONS_RUN_LOG, HEAD_SHA } = process.env
+if (!PR_URL) {
+  throw new Error('$PR_URL not set')
+}
+if (!SOURCE_BLOB_URL) {
+  throw new Error('$SOURCE_BLOB_URL not set')
+}
+if (!CONTEXT_NAME) {
+  throw new Error('$CONTEXT_NAME not set')
+}
+if (!ACTIONS_RUN_LOG) {
+  throw new Error('$ACTIONS_RUN_LOG not set')
+}
+if (!HEAD_SHA) {
+  throw new Error('$HEAD_SHA not set')
+}
+
+const { owner, repo, pullNumber } = parsePrUrl(PR_URL)
+if (!owner || !repo || !pullNumber) {
+  throw new Error(
+    `'pullRequestUrl' input must match URL format 'https://github.com/github/(docs|docs-internal)/pull/123' but was '${PR_URL}'`
+  )
+}
+
+const { data: pullRequest } = await octokit.pulls.get({
+  owner,
+  repo,
+  pull_number: pullNumber,
+})
+
+await deployToStaging({
+  octokit,
+  pullRequest,
+  forceRebuild: false,
+  // These parameters will ONLY be set by Actions
+  sourceBlobUrl: SOURCE_BLOB_URL,
+  runId: context.runId,
+})
+
+await github.repos.createCommitStatus({
+  owner,
+  repo,
+  sha: HEAD_SHA,
+  context: CONTEXT_NAME,
+  state: 'success',
+  description: 'Successfully deployed! See logs.',
+  target_url: ACTIONS_RUN_LOG,
+})

.github/workflows/staging-deploy-pr.yml

@@ -486,12 +486,8 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Install one-off development-only dependencies
-        run: npm install --no-save --include=optional esm
-
       - name: Deploy
         id: deploy
-        uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }}
@@ -503,69 +499,7 @@ jobs:
           ACTIONS_RUN_LOG: ${{ env.ACTIONS_RUN_LOG }}
           HEAD_SHA: ${{ needs.pr-metadata.outputs.head_sha }}
           ALLOWED_POLLING_FAILURES_PER_PHASE: '15'
-        with:
-          script: |
-            const { GITHUB_TOKEN, HEROKU_API_TOKEN } = process.env
-
-            // Exit if GitHub Actions PAT is not found
-            if (!GITHUB_TOKEN) {
-              throw new Error('You must supply a GITHUB_TOKEN environment variable!')
-            }
-
-            // Exit if Heroku API token is not found
-            if (!HEROKU_API_TOKEN) {
-              throw new Error('You must supply a HEROKU_API_TOKEN environment variable!')
-            }
-
-            // Workaround to allow us to load ESM files with `require(...)`
-            const esm = require('esm')
-            require = esm({})
-
-            const { default: parsePrUrl } = require('./script/deployment/parse-pr-url')
-            const { default: getOctokit } = require('./script/helpers/github')
-            const { default: deployToStaging } = require('./script/deployment/deploy-to-staging')
-
-            // This helper uses the `GITHUB_TOKEN` implicitly!
-            // We're using our usual version of Octokit vs. the provided `github`
-            // instance to avoid versioning discrepancies.
-            const octokit = getOctokit()
-
-            try {
-              const { PR_URL, SOURCE_BLOB_URL, CONTEXT_NAME, ACTIONS_RUN_LOG, HEAD_SHA } = process.env
-              const { owner, repo, pullNumber } = parsePrUrl(PR_URL)
-              if (!owner || !repo || !pullNumber) {
-                throw new Error(`'pullRequestUrl' input must match URL format 'https://github.com/github/(docs|docs-internal)/pull/123' but was '${PR_URL}'`)
-              }
-
-              const { data: pullRequest } = await octokit.pulls.get({
-                owner,
-                repo,
-                pull_number: pullNumber
-              })
-
-              await deployToStaging({
-                octokit,
-                pullRequest,
-                forceRebuild: false,
-                // These parameters will ONLY be set by Actions
-                sourceBlobUrl: SOURCE_BLOB_URL,
-                runId: context.runId
-              })
-
-              await github.repos.createCommitStatus({
-                owner,
-                repo,
-                sha: HEAD_SHA,
-                context: CONTEXT_NAME,
-                state: 'success',
-                description: 'Successfully deployed! See logs.',
-                target_url: ACTIONS_RUN_LOG
-              })
-            } catch (error) {
-              console.error(`Failed to deploy to staging: ${error.message}`)
-              console.error(error)
-              throw error
-            }
+        run: .github/actions-scripts/staging-deploy.js
 
       - name: Mark the deployment as inactive if timed out
         uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d