Merge branch 'main' into patch-2

Author: mchammer01

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

@@ -0,0 +1,74 @@
+#!/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 { RUN_ID, PR_URL, SOURCE_BLOB_URL, CONTEXT_NAME, ACTIONS_RUN_LOG, HEAD_SHA } = process.env
+if (!RUN_ID) {
+  throw new Error('$RUN_ID not set')
+}
+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: RUN_ID,
+})
+
+await octokit.repos.createCommitStatus({
+  owner,
+  repo,
+  sha: HEAD_SHA,
+  context: CONTEXT_NAME,
+  state: 'success',
+  description: 'Successfully deployed! See logs.',
+  target_url: ACTIONS_RUN_LOG,
+})

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

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+import parsePrUrl from '../../script/deployment/parse-pr-url.js'
+import getOctokit from '../../script/helpers/github.js'
+import undeployFromStaging from '../../script/deployment/undeploy-from-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 { RUN_ID, PR_URL } = process.env
+
+if (!RUN_ID) {
+  throw new Error('$RUN_ID not set')
+}
+if (!PR_URL) {
+  throw new Error('$PR_URL 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 undeployFromStaging({
+  octokit,
+  pullRequest: pullRequest,
+  runId: RUN_ID,
+})

.github/workflows/create-translation-batch-pr.yml

@@ -27,12 +27,12 @@ jobs:
         include:
           - language: pt-BR
             language_code: pt
-          # - language: zh-CN
-          #   language_code: cn
-          # - language: ja-JP
-          #   language_code: ja
-          # - language: es-ES
-          #   language_code: es
+          - language: zh-CN
+            language_code: cn
+          - language: ja-JP
+            language_code: ja
+          - language: es-ES
+            language_code: es
     steps:
       - name: Set branch name
         id: set-branch
@@ -89,7 +89,7 @@ jobs:
 
       - name: Commit crowdin sync
         run: |
-          git add .
+          git add translations/${{ matrix.language }}
           git commit -m "Add crowdin translations" || echo "Nothing to commit"
 
       - name: 'Setup node'
@@ -99,54 +99,62 @@ jobs:
 
       - run: npm ci
 
-      - name: Reset files with broken liquid tags
-        run: |
-          node script/i18n/reset-files-with-broken-liquid-tags.js --language=${{ matrix.language_code }}
-          git add . && git commit -m "run script/i18n/reset-files-with-broken-liquid-tags.js --language=${{ matrix.language_code }}" || echo "Nothing to commit"
-
-      # step 5 in docs-engineering/crowdin.md using script from docs-internal#22709
-      - name: Reset known broken files
-        run: |
-          node script/i18n/reset-known-broken-translation-files.js
-          git add . && git commit -m "run script/i18n/reset-known-broken-translation-files.js" || echo "Nothing to commit"
-        env:
-          GITHUB_TOKEN: ${{ secrets.DOCUBOT_REPO_PAT }}
-
       # step 6 in docs-engineering/crowdin.md
       - name: Homogenize frontmatter
         run: |
           node script/i18n/homogenize-frontmatter.js
-          git add . && git commit -m "Run script/i18n/homogenize-frontmatter.js" || echo "Nothing to commit"
+          git add translations/${{ matrix.language }} && git commit -m "Run script/i18n/homogenize-frontmatter.js" || echo "Nothing to commit"
 
       # step 7 in docs-engineering/crowdin.md
       - name: Fix translation errors
         run: |
           node script/i18n/fix-translation-errors.js
-          git add . && git commit -m "Run script/i18n/fix-translation-errors.js" || echo "Nothing to commit"
+          git add translations/${{ matrix.language }} && git commit -m "Run script/i18n/fix-translation-errors.js" || echo "Nothing to commit"
 
       # step 8a in docs-engineering/crowdin.md
       - name: Check parsing
         run: |
-          node script/i18n/lint-translation-files.js --check parsing
-          git add . && git commit -m "Run script/i18n/lint-translation-files.js --check parsing" || echo "Nothing to commit"
+          node script/i18n/lint-translation-files.js --check parsing | tee -a /tmp/batch.log | cat
+          git add translations/${{ matrix.language }} && git commit -m "Run script/i18n/lint-translation-files.js --check parsing" || echo "Nothing to commit"
 
       # step 8b in docs-engineering/crowdin.md
       - name: Check rendering
         run: |
-          node script/i18n/lint-translation-files.js --check rendering
-          git add . && git commit -m "Run script/i18n/lint-translation-files.js --check rendering" || echo "Nothing to commit"
+          node script/i18n/lint-translation-files.js --check rendering | tee -a /tmp/batch.log | cat
+          git add translations/${{ matrix.language }} && git commit -m "Run script/i18n/lint-translation-files.js --check rendering" || echo "Nothing to commit"
+
+      - name: Reset files with broken liquid tags
+        run: |
+          node script/i18n/reset-files-with-broken-liquid-tags.js --language=${{ matrix.language_code }} | tee -a /tmp/batch.log | cat
+          git add translations/${{ matrix.language }} && git commit -m "run script/i18n/reset-files-with-broken-liquid-tags.js --language=${{ matrix.language_code }}" || echo "Nothing to commit"
+
+      # step 5 in docs-engineering/crowdin.md using script from docs-internal#22709
+      - name: Reset known broken files
+        run: |
+          node script/i18n/reset-known-broken-translation-files.js | tee -a /tmp/batch.log | cat
+          git add translations/${{ matrix.language }} && git commit -m "run script/i18n/reset-known-broken-translation-files.js" || echo "Nothing to commit"
+        env:
+          GITHUB_TOKEN: ${{ secrets.DOCUBOT_REPO_PAT }}
+
+      - name: Check in CSV report
+        run: |
+          mkdir -p log
+          csvFile=log/${{ matrix.language_code }}-resets.csv
+          script/i18n/report-reset-files.js --report-type=csv --language=${{ matrix.language_code }} --log-file=/tmp/batch.log > $csvFile
+          git add -f $csvFile && git commit -m "Check in ${{ matrix.language }} CSV report" || echo "Nothing to commit"
 
       - name: Create Pull Request
         env:
           GITHUB_TOKEN: ${{ secrets.DOCUBOT_REPO_PAT }}
         # We'll try to create the pull request based on the changes we pushed up in the branch.
         # If there are actually no differences between the branch and `main`, we'll delete it.
         run: |
+          script/i18n/report-reset-files.js --report-type=pull-request-body --language=${{ matrix.language_code }} --log-file=/tmp/batch.log > /tmp/pr-body.txt
           git push origin ${{ steps.set-branch.outputs.BRANCH_NAME }}
-          gh pr create -t "New translation batch for ${{ matrix.language }}" \
+          gh pr create --title "New translation batch for ${{ matrix.language }}" \
             --base=main \
             --head=${{ steps.set-branch.outputs.BRANCH_NAME }} \
-            -b "New batch for ${{ matrix.language }} created by [this workflow]($GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID)" ||  git push origin :${{ steps.set-branch.outputs.BRANCH_NAME }}
+            --body-file /tmp/pr-body.txt || git push origin :${{ steps.set-branch.outputs.BRANCH_NAME }}
 
       # When the maximum execution time is reached for this job, Actions cancels the workflow run.
       # This emits a notification for the first responder to triage.

.github/workflows/prod-build-deploy.yml

@@ -21,7 +21,7 @@ concurrency:
 jobs:
   build-and-deploy:
     if: ${{ github.repository == 'github/docs-internal'}}
-    runs-on: ubuntu-latest
+    runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
     timeout-minutes: 15
     steps:
       - name: Check out repo

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

@@ -67,6 +67,10 @@ jobs:
           BUILD_ACTIONS_RUN_ID: ${{ env.BUILD_ACTIONS_RUN_ID }}
         with:
           script: |
+
+            // Curious about what version of node you get
+            console.log('Node version:', process.version)
+
             // In order to find out the PR info for a forked repo, we must query
             // the API for more info based on the originating workflow run
             const { BUILD_ACTIONS_RUN_ID } = process.env
@@ -482,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 }}
@@ -499,69 +499,8 @@ 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_ID: ${{ github.run_id }}
+        run: .github/actions-scripts/staging-deploy.js
 
       - name: Mark the deployment as inactive if timed out
         uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d

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

@@ -69,51 +69,13 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Install one-off development-only dependencies
-        run: npm install --no-save --include=optional esm
-
       - name: Undeploy
-        uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           HEROKU_API_TOKEN: ${{ secrets.HEROKU_API_TOKEN }}
-        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: getOctokit } = require('./script/helpers/github')
-            const { default: undeployFromStaging } = require('./script/deployment/undeploy-from-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 {
-              await undeployFromStaging({
-                octokit,
-                pullRequest: context.payload.pull_request,
-                runId: context.runId
-              })
-            } catch (error) {
-              console.error(`Failed to undeploy from staging: ${error.message}`)
-              console.error(error)
-              throw error
-            }
+          RUN_ID: ${{ github.run_id }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
+        run: .github/actions-scripts/staging-undeploy.js
 
       - if: ${{ always() }}
         name: Remove the label from the PR to unblock deployment