Merge branch 'main' into patch-2

Author: janiceilene

.eslintrc.js

@@ -13,7 +13,7 @@ module.exports = {
     babelOptions: { configFile: './.babelrc' },
     sourceType: 'module',
   },
-  ignorePatterns: ['tmp/*', '!/.*', '/.next/', 'script/bookmarklets/*', 'lib/sigsci.js'],
+  ignorePatterns: ['tmp/*', '!/.*', '/.next/', 'script/bookmarklets/*'],
   rules: {
     'import/no-extraneous-dependencies': ['error', { packageDir: '.' }],
   },

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

@@ -20,6 +20,11 @@ if (!APP_URL) {
   throw new Error(`APP_URL environment variable not set`)
 }
 
+// the max size of the comment (in bytes)
+// the action we use to post the comment caps out at about 144kb
+// see docs-engineering#1849 for more info
+const MAX_COMMENT_SIZE = 125000
+
 const PROD_URL = 'https://docs.github.com'
 const octokit = github.getOctokit(GITHUB_TOKEN)
 
@@ -39,78 +44,117 @@ 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('.'))
-
-  // get the file contents and decode them
-  // this script is called from the main branch, so we need the API call to get the contents from the branch, instead
-  const fileContents = await getContents(
-    context.repo.owner,
-    context.payload.repository.name,
-    context.payload.pull_request.head.sha,
-    file.filename
-  )
-
-  // parse the frontmatter
-  const { data } = parse(fileContents)
-
-  let contentCell = ''
-  let previewCell = ''
-  let prodCell = ''
-
-  if (file.status === 'added') contentCell = `New file: `
-  contentCell += `[\`${fileName}\`](${sourceUrl})`
-
-  try {
-    // the try/catch is needed because getApplicableVersions() returns either [] or throws an error when it can't parse the versions frontmatter
-    // try/catch can be removed if docs-engineering#1821 is resolved
-    // i.e. for feature based versioning, like ghae: 'issue-6337'
-    const fileVersions = getApplicableVersions(data.versions)
-
-    for (const plan in allVersionShortnames) {
-      // plan is the shortName (i.e., fpt)
-      // allVersionShortNames[plan] is the planName (i.e., free-pro-team)
-
-      // walk by the plan names since we generate links differently for most plans
-      const versions = fileVersions.filter((fileVersion) =>
-        fileVersion.includes(allVersionShortnames[plan])
-      )
-
-      if (versions.length === 1) {
-        // for fpt, ghec, and ghae
 
-        if (versions.toString() === nonEnterpriseDefaultVersion) {
-          // omit version from fpt url
-
-          previewCell += `[${plan}](${APP_URL}/${fileUrl})<br>`
-          prodCell += `[${plan}](${PROD_URL}/${fileUrl})<br>`
-        } else {
-          // for non-versioned releases (ghae, ghec) use full url
+const lines = await Promise.all(
+  articleFiles.map(async (file) => {
+    const sourceUrl = file.blob_url
+    const fileName = file.filename.slice(pathPrefix.length)
+    const fileUrl = fileName.slice(0, fileName.lastIndexOf('.'))
+
+    // get the file contents and decode them
+    // this script is called from the main branch, so we need the API call to get the contents from the branch, instead
+    const fileContents = await getContents(
+      context.repo.owner,
+      context.payload.repository.name,
+      // Can't get its content if it no longer exists.
+      // Meaning, you'd get a 404 on the `getContents()` utility function.
+      // So, to be able to get necessary meta data about what it *was*,
+      // if it was removed, fall back to the 'base'.
+      file.status === 'removed'
+        ? context.payload.pull_request.base.sha
+        : context.payload.pull_request.head.sha,
+      file.filename
+    )
 
-          previewCell += `[${plan}](${APP_URL}/${versions}/${fileUrl})<br>`
-          prodCell += `[${plan}](${PROD_URL}/${versions}/${fileUrl})<br>`
+    // parse the frontmatter
+    const { data } = parse(fileContents)
+
+    let contentCell = ''
+    let previewCell = ''
+    let prodCell = ''
+
+    if (file.status === 'added') contentCell = 'New file: '
+    else if (file.status === 'removed') contentCell = 'Removed: '
+    contentCell += `[\`${fileName}\`](${sourceUrl})`
+
+    try {
+      // the try/catch is needed because getApplicableVersions() returns either [] or throws an error when it can't parse the versions frontmatter
+      // try/catch can be removed if docs-engineering#1821 is resolved
+      // i.e. for feature based versioning, like ghae: 'issue-6337'
+      const fileVersions = getApplicableVersions(data.versions)
+
+      for (const plan in allVersionShortnames) {
+        // plan is the shortName (i.e., fpt)
+        // allVersionShortNames[plan] is the planName (i.e., free-pro-team)
+
+        // walk by the plan names since we generate links differently for most plans
+        const versions = fileVersions.filter((fileVersion) =>
+          fileVersion.includes(allVersionShortnames[plan])
+        )
+
+        if (versions.length === 1) {
+          // for fpt, ghec, and ghae
+
+          if (versions.toString() === nonEnterpriseDefaultVersion) {
+            // omit version from fpt url
+
+            previewCell += `[${plan}](${APP_URL}/${fileUrl})<br>`
+            prodCell += `[${plan}](${PROD_URL}/${fileUrl})<br>`
+          } else {
+            // for non-versioned releases (ghae, ghec) use full url
+
+            previewCell += `[${plan}](${APP_URL}/${versions}/${fileUrl})<br>`
+            prodCell += `[${plan}](${PROD_URL}/${versions}/${fileUrl})<br>`
+          }
+        } else if (versions.length) {
+          // for ghes releases, link each version
+
+          previewCell += `${plan}@ `
+          prodCell += `${plan}@ `
+
+          versions.forEach((version) => {
+            previewCell += `[${version.split('@')[1]}](${APP_URL}/${version}/${fileUrl}) `
+            prodCell += `[${version.split('@')[1]}](${PROD_URL}/${version}/${fileUrl}) `
+          })
+          previewCell += '<br>'
+          prodCell += '<br>'
         }
-      } else if (versions.length) {
-        // for ghes releases, link each version
-
-        previewCell += `${plan}@ `
-        prodCell += `${plan}@ `
-
-        versions.forEach((version) => {
-          previewCell += `[${version.split('@')[1]}](${APP_URL}/${version}/${fileUrl}) `
-          prodCell += `[${version.split('@')[1]}](${PROD_URL}/${version}/${fileUrl}) `
-        })
-        previewCell += '<br>'
-        prodCell += '<br>'
       }
+    } catch (e) {
+      console.error(
+        `Version information for ${file.filename} couldn't be determined from its frontmatter.`
+      )
     }
-  } catch (e) {
-    console.error(
-      `Version information for ${file.filename} couldn't be determined from its frontmatter.`
-    )
+    let note = ''
+    if (file.status === 'removed') {
+      note = 'removed'
+      // If the file was removed, the `previewCell` no longer makes sense
+      // since it was based on looking at the base sha.
+      previewCell = 'n/a'
+    }
+
+    return `| ${contentCell} | ${previewCell} | ${prodCell} | ${note} |`
+  })
+)
+
+// this section limits the size of the comment
+const cappedLines = []
+let underMax = true
+
+lines.reduce((previous, current, index, array) => {
+  if (underMax) {
+    if (previous + current.length > MAX_COMMENT_SIZE) {
+      underMax = false
+      cappedLines.push('**Note** There are more changes in this PR than we can show.')
+      return previous
+    }
+
+    cappedLines.push(array[index])
+    return previous + current.length
   }
-  markdownTable += `| ${contentCell} | ${previewCell} | ${prodCell} | |\n`
-}
+  return previous
+}, markdownTable.length)
+
+markdownTable += cappedLines.join('\n')
+
 setOutput('changesTable', markdownTable)

.github/workflows/autoupdate-branch.yml

@@ -43,9 +43,9 @@ jobs:
         uses: actions/checkout@dcd71f646680f2efd8db4afa5ad64fdcba30e748
 
       - name: Setup Node
-        uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561
+        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048
         with:
-          node-version: 16.15.x
+          node-version: '16.15.0'
           cache: npm
 
       - name: Install dependencies

.github/workflows/azure-preview-env-deploy.yml

@@ -188,7 +188,7 @@ jobs:
           # `main-docker-cache.yml` handles updating the remote cache so we don't pollute it with PR specific code
           cache-to: ''
           build-args: |
-            BUILD_SHA=${{ github.sha }}
+            BUILD_SHA=${{ env.COMMIT_REF }}
 
       # Succeed despite any non-zero exit code (e.g. if there is no deployment to cancel)
       - name: 'Cancel any existing deployments for this PR'
@@ -198,7 +198,16 @@ jobs:
       # Deploy ARM template is idempotent
       # Note: once the resources exist the image tag must change for a new deployment to occur (the image tag includes workflow run number, run attempt, as well as sha)
       - name: Run ARM deploy
-        id: deploy
+        # This 'if' will be truth, if this workflow is...
+        #  - run as a workflow_dispatch
+        #  - run because of a push to main (or gh-readonly-queue/main)
+        #  - run as a regular pull request
+        # But if it's a pull request, *and* for whatever reason, the pull
+        # request has "Auto-merge" enabled, don't bother.
+        # The idea is that if auto-merge has been abled, by humans or by
+        # bots, they have no intention of viewing the deployed preview anyway.
+        # This saves time because the PR can merge sooner.
+        if: ${{ !github.event.pull_request.auto_merge }}
         uses: azure/arm-deploy@841b12551939c88af8f6df767c24c38a5620fd0d
         with:
           resourceGroupName: ${{ secrets.PREVIEW_ENV_RESOURCE_GROUP }}

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

@@ -60,9 +60,9 @@ jobs:
         run: git lfs checkout
 
       - name: Setup node
-        uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561
+        uses: actions/setup-node@17f8bd926464a1afa4c6a11669539e9c1ba77048
         with:
-          node-version: 16.15.x
+          node-version: '16.15.0'
           cache: npm
 
       - name: Clone docs-early-access