Merge branch 'main' into patch-2

Author: mchammer01

.github/actions-scripts/content-changes-table-comment.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+
+import createStagingAppName from '../../script/deployment/create-staging-app-name.js'
+import * as github from '@actions/github'
+import { setOutput } from '@actions/core'
+
+const context = github.context
+
+const githubToken = process.env.GITHUB_TOKEN
+if (!githubToken) {
+  throw new Error(`GITHUB_TOKEN environment variable not set`)
+}
+
+const stagingPrefix = createStagingAppName({
+  repo: context.payload.repository.name,
+  pullNumber: context.payload.number,
+  branch: context.payload.pull_request.head.ref,
+})
+
+const octokit = github.getOctokit(githubToken)
+
+const response = await octokit.rest.repos.compareCommits({
+  owner: context.repo.owner,
+  repo: context.payload.repository.name,
+  base: context.payload.pull_request.base.sha,
+  head: context.payload.pull_request.head.sha,
+})
+
+const { files } = response.data
+
+let markdownTable =
+  '| **Source** | **Staging** | **Production** | **What Changed** |\n|:----------- |:----------- |:----------- |:----------- |\n'
+
+const pathPrefix = 'content/'
+const articleFiles = files.filter(
+  ({ filename }) => filename.startsWith(pathPrefix) && !filename.endsWith('/index.md')
+)
+for (const file of articleFiles) {
+  const sourceUrl = file.blob_url
+  const fileName = file.filename.slice(pathPrefix.length)
+  const fileUrl = fileName.slice(0, fileName.lastIndexOf('.'))
+  const stagingLink = `https://${stagingPrefix}.herokuapp.com/${fileUrl}`
+  const productionLink = `https://docs.github.com/${fileUrl}`
+  let markdownLine = ''
+
+  if (file.status === 'modified') {
+    markdownLine = `| [content/${fileName}](${sourceUrl}) | [Modified](${stagingLink}) | [Original](${productionLink}) | |\n`
+  } else if (file.status === 'added') {
+    markdownLine = `| New file: [content/${fileName}](${sourceUrl}) | [Modified](${stagingLink}) | | |\n`
+  }
+  markdownTable += markdownLine
+}
+
+setOutput('changesTable', markdownTable)

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

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+
+import getOctokit from '../../script/helpers/github.js'
+import deployToProduction from '../../script/deployment/deploy-to-production.js'
+
+const {
+  GITHUB_TOKEN,
+  HEROKU_API_TOKEN,
+  HEROKU_PRODUCTION_APP_NAME,
+  SOURCE_BLOB_URL,
+  DELAY_FOR_PREBOOT,
+  RUN_ID,
+} = 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!')
+}
+
+// Exit if Heroku App name is not found
+if (!HEROKU_PRODUCTION_APP_NAME) {
+  throw new Error('You must supply a HEROKU_PRODUCTION_APP_NAME environment variable!')
+}
+
+if (!RUN_ID) {
+  throw new Error('$RUN_ID not set')
+}
+
+// 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 deployToProduction({
+    octokit,
+    includeDelayForPreboot: DELAY_FOR_PREBOOT !== 'false',
+    // These parameters will ONLY be set by Actions
+    sourceBlobUrl: SOURCE_BLOB_URL,
+    runId: RUN_ID,
+  })
+} catch (error) {
+  console.error(`Failed to deploy to production: ${error.message}`)
+  console.error(error)
+  throw error
+}

.github/actions-scripts/purge-fastly-edge-cache.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+import purgeEdgeCache from '../../script/deployment/purge-edge-cache.js'
+
+try {
+  await purgeEdgeCache()
+} catch (error) {
+  console.error(`Failed to purge the edge cache: ${error.message}`)
+  console.error(error)
+  throw error
+}

.github/workflows/content-changes-table-comment.yml

@@ -49,57 +49,12 @@ jobs:
       - name: Install temporary dependencies
         run: |
           npm install --no-save github-slugger
-          npm install --no-save --include=optional esm
 
       - name: Get changes table
-        uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
         id: changes
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          script: |
-            // Workaround to allow us to load ESM files with `require(...)`
-            const esm = require('esm')
-            require = esm({})
-
-            const { default: createStagingAppName } = require('./script/deployment/create-staging-app-name')
-
-            const stagingPrefix = createStagingAppName({
-              repo: context.payload.repository.name,
-              pullNumber: context.payload.number,
-              branch: context.payload.pull_request.head.ref,
-            })
-
-            const response = await github.repos.compareCommits({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              base: context.payload.pull_request.base.sha,
-              head: context.payload.pull_request.head.sha
-            })
-
-            const files = response.data.files
-
-            let markdownTable = '| **Source** | **Staging** | **Production** | **What Changed** |\n|:----------- |:----------- |:----------- |:----------- |\n'
-
-            const pathPrefix = 'content/'
-            const articleFiles = files.filter(({ filename }) => filename.startsWith(pathPrefix) && !filename.endsWith('/index.md'))
-            for (const file of articleFiles) {
-              const sourceUrl = file.blob_url
-              const fileName = file.filename.slice(pathPrefix.length)
-              const fileUrl = fileName.slice(0, fileName.lastIndexOf('.'))
-              const stagingLink = `https://${stagingPrefix}.herokuapp.com/${fileUrl}`
-              const productionLink = `https://docs.github.com/${fileUrl}`
-              let markdownLine = ''
-
-              if (file.status === 'modified') {
-                markdownLine = `| [content/${fileName}](${sourceUrl}) | [Modified](${stagingLink}) | [Original](${productionLink}) | |\n`
-              } else if (file.status === 'added') {
-                markdownLine = `| New file: [content/${fileName}](${sourceUrl}) | [Modified](${stagingLink}) | | |\n`
-              }
-              markdownTable += markdownLine
-            }
-
-            core.setOutput('changesTable', markdownTable)
+        run: .github/actions-scripts/content-changes-table-comment.js
 
       - name: Find content directory changes comment
         uses: peter-evans/find-comment@d2dae40ed151c634e4189471272b57e76ec19ba8

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

@@ -138,8 +138,8 @@ jobs:
 
       - name: Check in CSV report
         run: |
-          mkdir -p log
-          csvFile=log/${{ matrix.language_code }}-resets.csv
+          mkdir -p translations/log
+          csvFile=translations/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"
 

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

@@ -21,7 +21,7 @@ concurrency:
 jobs:
   build-and-deploy:
     if: ${{ github.repository == 'github/docs-internal'}}
-    runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
+    runs-on: ubuntu-latest
     timeout-minutes: 15
     steps:
       - name: Check out repo
@@ -129,12 +129,8 @@ jobs:
             -H 'Content-Type:' \
             --data-binary @app.tar.gz
 
-      - 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 }}
@@ -144,56 +140,8 @@ jobs:
           SOURCE_BLOB_URL: ${{ steps.build-source.outputs.download_url }}
           DELAY_FOR_PREBOOT: 'true'
           ALLOWED_POLLING_FAILURES_PER_PHASE: '15'
-        with:
-          script: |
-            const {
-              GITHUB_TOKEN,
-              HEROKU_API_TOKEN,
-              HEROKU_PRODUCTION_APP_NAME,
-              SOURCE_BLOB_URL,
-              DELAY_FOR_PREBOOT
-            } = 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!')
-            }
-
-            // Exit if Heroku App name is not found
-            if (!HEROKU_PRODUCTION_APP_NAME) {
-              throw new Error('You must supply a HEROKU_PRODUCTION_APP_NAME 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: deployToProduction } = require('./script/deployment/deploy-to-production')
-
-            // 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 deployToProduction({
-                octokit,
-                includeDelayForPreboot: DELAY_FOR_PREBOOT !== 'false',
-                // These parameters will ONLY be set by Actions
-                sourceBlobUrl: SOURCE_BLOB_URL,
-                runId: context.runId
-              })
-            } catch (error) {
-              console.error(`Failed to deploy to production: ${error.message}`)
-              console.error(error)
-              throw error
-            }
+          RUN_ID: ${{ github.run_id }}
+        run: .github/actions-scripts/prod-deploy.js
 
       - name: Mark the deployment as inactive if timed out
         uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
@@ -227,26 +175,11 @@ jobs:
             console.log('⏲️ Deployment status: error - The deployment timed out...')
 
       - name: Purge Fastly edge cache
-        uses: actions/github-script@2b34a689ec86a68d8ab9478298f91d5401337b7d
         env:
           FASTLY_TOKEN: ${{ secrets.FASTLY_TOKEN }}
           FASTLY_SERVICE_ID: ${{ secrets.FASTLY_SERVICE_ID }}
           FASTLY_SURROGATE_KEY: 'all-the-things'
-        with:
-          script: |
-            // Workaround to allow us to load ESM files with `require(...)`
-            const esm = require('esm')
-            require = esm({})
-
-            const { default: purgeEdgeCache } = require('./script/deployment/purge-edge-cache')
-
-            try {
-              await purgeEdgeCache()
-            } catch (error) {
-              console.error(`Failed to purge the edge cache: ${error.message}`)
-              console.error(error)
-              throw error
-            }
+        run: .github/actions-scripts/purge-fastly-edge-cache.js
 
       - name: Send Slack notification if workflow failed
         uses: someimportantcompany/github-actions-slack-message@f8d28715e7b8a4717047d23f48c39827cacad340

components/article/ToolPicker.tsx

@@ -80,11 +80,15 @@ export const ToolPicker = ({ variant = 'subnav' }: Props) => {
     }
   }, [])
 
-  function onClickTool(tool: string) {
-    setCurrentTool(tool)
+  // Whenever the currentTool is changed, update the article content
+  useEffect(() => {
     preserveAnchorNodePosition(document, () => {
-      showToolSpecificContent(tool)
+      showToolSpecificContent(currentTool)
     })
+  }, [currentTool])
+
+  function onClickTool(tool: string) {
+    setCurrentTool(tool)
     sendEvent({
       type: EventType.preference,
       preference_name: 'application',

content/actions/learn-github-actions/reusing-workflows.md

@@ -70,6 +70,7 @@ Called workflows can access self-hosted runners from caller's context. This mean
 * Reusable workflows stored within a private repository can only be used by workflows within the same repository.
 * Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)."
 * You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs.<job_id>.concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)."
+* The `strategy` property is not supported in any job that calls a reusable workflow.
 
 ## Creating a reusable workflow