Merge branch 'main' into patch-2

Author: skedwards88

.eslintrc.js

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

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

@@ -7,6 +7,7 @@ import { getContents } from '../../script/helpers/git-utils.js'
 import parse from '../../lib/read-frontmatter.js'
 import getApplicableVersions from '../../lib/get-applicable-versions.js'
 import nonEnterpriseDefaultVersion from '../../lib/non-enterprise-default-version.js'
+import { allVersionShortnames } from '../../lib/all-versions.js'
 
 const { GITHUB_TOKEN, APP_URL } = process.env
 const context = github.context
@@ -22,6 +23,7 @@ if (!APP_URL) {
 const PROD_URL = 'https://docs.github.com'
 const octokit = github.getOctokit(GITHUB_TOKEN)
 
+// get the list of file changes from the PR
 const response = await octokit.rest.repos.compareCommitsWithBasehead({
   owner: context.repo.owner,
   repo: context.payload.repository.name,
@@ -61,36 +63,54 @@ for (const file of articleFiles) {
   if (file.status === 'added') contentCell = `New file: `
   contentCell += `[\`${fileName}\`](${sourceUrl})`
 
-  for (const version in data.versions) {
-    const currentApplicableVersions = getApplicableVersions({
-      [version]: data.versions[version],
-    })
-
-    if (currentApplicableVersions.length === 1) {
-      // for fpt, ghec, and ghae
-      if (currentApplicableVersions.toString() === nonEnterpriseDefaultVersion) {
-        // omit version from fpt url
-        previewCell += `[${version}](${APP_URL}/${fileUrl})<br>`
-        prodCell += `[${version}](${PROD_URL}/${fileUrl})<br>`
-      } else {
-        // for non-versioned releases (ghae, ghec) use full url
-        previewCell += `[${version}](${APP_URL}/${currentApplicableVersions}/${fileUrl})<br>`
-        prodCell += `[${version}](${PROD_URL}/${currentApplicableVersions}/${fileUrl})<br>`
+  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 {
-      // for ghes releases, link each version
-      previewCell += `${version}@ `
-      prodCell += `${version}@ `
-
-      currentApplicableVersions.forEach((ghesVersion) => {
-        previewCell += `[${ghesVersion.split('@')[1]}](${APP_URL}/${ghesVersion}/${fileUrl}) `
-        prodCell += `[${ghesVersion.split('@')[1]}](${PROD_URL}/${ghesVersion}/${fileUrl}) `
-      })
-      previewCell += '<br>'
-      prodCell += '<br>'
     }
+  } catch (e) {
+    console.error(
+      `Version information for ${file.filename} couldn't be determined from its frontmatter.`
+    )
   }
   markdownTable += `| ${contentCell} | ${previewCell} | ${prodCell} | |\n`
 }
-
 setOutput('changesTable', markdownTable)

.github/actions-scripts/enable-automerge.js

@@ -17,7 +17,7 @@ async function main() {
   const github = getOctokit(token)
   const pull = await github.rest.pulls.get({
     owner: org,
-    repo: repo,
+    repo,
     pull_number: parseInt(prNumber),
   })
 

.github/actions-scripts/enterprise-server-issue-templates/release-issue.md

@@ -110,20 +110,20 @@ This file should be automatically updated, but you can also run `script/update-e
 
 ### 🚢 🛳️ 🚢 Shipping the release branch
 
-- [ ] Remove `[DO NOT MERGE]` and other meta information from the PR title 😜.
-- [ ] The `github/docs-internal` repo is frozen, and the `Repo Freeze Check / Prevent merging during deployment freezes (pull_request_target)` test is expected to fail.
-
-  Use admin permissions to ship the release branch with this failure. Make sure that the merge's commit title does not include anything like `[DO NOT MERGE]`, and remove all the branch's commit details from the merge's commit message except for the co-author list.
-- [ ] Do any required smoke tests listed in the opening post in the megabranch PR. You can monitor and check when the production deploy completed by viewing the [`docs-internal` deployments page](https://github.com/github/docs-internal/deployments).
-- [ ] Once smoke tests have passed, you can [unfreeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) and post an announcement in Slack.
-- [ ] After unfreezing, the megabranch creator should push the search index LFS objects for the public `github/docs` repo. The LFS objects were already pushed for the internal repo after the `sync-english-index-for-<PLAN@RELEASE>` was added to the megabranch. To push the LFS objects to the public repo:
+- [ ] The megabranch creator should push the search index LFS objects for the public `github/docs` repo. The LFS objects were already pushed for the internal repo after the `sync-english-index-for-<PLAN@RELEASE>` was added to the megabranch. To push the LFS objects to the public repo:
   1. First navigate to the [sync search indices workflow](https://github.com/github/docs-internal/actions/workflows/sync-search-indices.yml). 
   2. Then, to run the workflow with parameters, click on `Run workflow` button. 
   3. A modal will pop up where you will set the following inputs:
-     - Branch: The new version megabranch you're working on
+     - Branch: The new `ghes-<RELEASE>-megabranch` version megabranch you're working on
      - Version: `enterprise-server@<RELEASE>`
      - Language: `en`
   4. Run the job. The workflow job may fail on the first run—so retry the failed job if needed.
+- [ ] Remove `[DO NOT MERGE]` and other meta information from the PR title 😜.
+- [ ] The `github/docs-internal` repo is frozen, and the `Repo Freeze Check / Prevent merging during deployment freezes (pull_request_target)` test is expected to fail.
+
+  Use admin permissions to ship the release branch with this failure. Make sure that the merge's commit title does not include anything like `[DO NOT MERGE]`, and remove all the branch's commit details from the merge's commit message except for the co-author list.
+- [ ] Do any required smoke tests listed in the opening post in the megabranch PR. You can monitor and check when the production deploy completed by viewing the [`docs-internal` deployments page](https://github.com/github/docs-internal/deployments).
+- [ ] Once smoke tests have passed, you can [unfreeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) and post an announcement in Slack.
 - [ ] After unfreezing, alert the Ecosystem-API team in #ecosystem-api the docs freeze is finished/thawed and the release has shipped. 
   - [ ] You (or they) can now remove your blocking review on the auto-generated "Update OpenAPI Descriptions" PR in public REST API description (the `rest-api-descriptions` repo). (although it's likely newer PRs have been created since yours with the blocking review, in which case the Ecosystem-API team will close your PR and perform the next step on the most recent PR).
   - [ ] The Ecosystem-API team will merge the latest auto-generated "Update OpenAPI Descriptions" PR (which will contain the OpenAPI schema config that changed `published` to `true` for the release).

.github/actions-scripts/fr-add-docs-reviewers-requests.js

@@ -191,16 +191,16 @@ async function run() {
 
     await graphql(updateProjectNextItemMutation, {
       project: projectID,
-      statusID: statusID,
+      statusID,
       statusValueID: readyForReviewID,
-      datePostedID: datePostedID,
-      reviewDueDateID: reviewDueDateID,
-      contributorTypeID: contributorTypeID,
-      contributorType: contributorType,
-      sizeTypeID: sizeTypeID,
+      datePostedID,
+      reviewDueDateID,
+      contributorTypeID,
+      contributorType,
+      sizeTypeID,
       sizeType: '', // Although we aren't populating size, we are passing the variable so that we can use the shared mutation function
-      featureID: featureID,
-      authorID: authorID,
+      featureID,
+      authorID,
       headers: {
         authorization: `token ${process.env.TOKEN}`,
         'GraphQL-Features': 'projects_next_graphql',

.github/actions-scripts/msft-create-translation-batch-pr.js

@@ -0,0 +1,142 @@
+#!/usr/bin/env node
+
+import fs from 'fs'
+import github from '@actions/github'
+
+const OPTIONS = Object.fromEntries(
+  ['BASE', 'BODY_FILE', 'GITHUB_TOKEN', 'HEAD', 'LANGUAGE', 'TITLE', 'GITHUB_REPOSITORY'].map(
+    (envVarName) => {
+      const envVarValue = process.env[envVarName]
+      if (!envVarValue) {
+        throw new Error(`You must supply a ${envVarName} environment variable`)
+      }
+      return [envVarName, envVarValue]
+    }
+  )
+)
+
+if (!process.env.GITHUB_REPOSITORY) {
+  throw new Error('GITHUB_REPOSITORY environment variable not set')
+}
+
+const RETRY_STATUSES = [
+  422, // Retry the operation if the PR already exists
+  502, // Retry the operation if the API responds with a `502 Bad Gateway` error.
+]
+const RETRY_ATTEMPTS = 3
+const {
+  // One of the default environment variables provided by Actions.
+  GITHUB_REPOSITORY,
+
+  // These are passed in from the step in the workflow file.
+  TITLE,
+  BASE,
+  HEAD,
+  LANGUAGE,
+  BODY_FILE,
+  GITHUB_TOKEN,
+} = OPTIONS
+const [OWNER, REPO] = GITHUB_REPOSITORY.split('/')
+
+const octokit = github.getOctokit(GITHUB_TOKEN)
+
+/**
+ * @param {object} config Configuration options for finding the PR.
+ * @returns {Promise<number | undefined>} The PR number.
+ */
+async function findPullRequestNumber(config) {
+  // Get a list of PRs and see if one already exists.
+  const { data: listOfPullRequests } = await octokit.rest.pulls.list({
+    owner: config.owner,
+    repo: config.repo,
+    head: `${config.owner}:${config.head}`,
+  })
+
+  return listOfPullRequests[0]?.number
+}
+
+/**
+ * When this file was first created, we only introduced support for creating a pull request for some translation batch.
+ * However, some of our first workflow runs failed during the pull request creation due to a timeout error.
+ * There have been cases where, despite the timeout error, the pull request gets created _anyway_.
+ * To accommodate this reality, we created this function to look for an existing pull request before a new one is created.
+ * Although the "find" check is redundant in the first "cycle", it's designed this way to recursively call the function again via its retry mechanism should that be necessary.
+ *
+ * @param {object} config Configuration options for creating the pull request.
+ * @returns {Promise<number>} The PR number.
+ */
+async function findOrCreatePullRequest(config) {
+  const found = await findPullRequestNumber(config)
+
+  if (found) {
+    return found
+  }
+
+  try {
+    const { data: pullRequest } = await octokit.rest.pulls.create({
+      owner: config.owner,
+      repo: config.repo,
+      base: config.base,
+      head: config.head,
+      title: config.title,
+      body: config.body,
+      draft: false,
+    })
+
+    return pullRequest.number
+  } catch (error) {
+    if (!error.response || !config.retryCount) {
+      throw error
+    }
+
+    if (!config.retryStatuses.includes(error.response.status)) {
+      throw error
+    }
+
+    console.error(`Error creating pull request: ${error.message}`)
+    console.warn(`Retrying in 5 seconds...`)
+    await new Promise((resolve) => setTimeout(resolve, 5000))
+
+    config.retryCount -= 1
+
+    return findOrCreatePullRequest(config)
+  }
+}
+
+/**
+ * @param {object} config Configuration options for labeling the PR
+ * @returns {Promise<undefined>}
+ */
+// async function labelPullRequest(config) {
+//   await octokit.rest.issues.update({
+//     owner: config.owner,
+//     repo: config.repo,
+//     issue_number: config.issue_number,
+//     labels: config.labels,
+//   })
+// }
+
+async function main() {
+  const options = {
+    title: TITLE,
+    base: BASE,
+    head: HEAD,
+    body: fs.readFileSync(BODY_FILE, 'utf8'),
+    labels: ['translation-batch', `translation-batch-${LANGUAGE}`],
+    owner: OWNER,
+    repo: REPO,
+    retryStatuses: RETRY_STATUSES,
+    retryCount: RETRY_ATTEMPTS,
+  }
+
+  options.issue_number = await findOrCreatePullRequest(options)
+  const pr = `${GITHUB_REPOSITORY}#${options.issue_number}`
+  console.log(`Created PR ${pr}`)
+
+  // metadata parameters aren't currently available in `github.rest.pulls.create`,
+  // but they are in `github.rest.issues.update`.
+  // await labelPullRequest(options)
+  // console.log(`Updated ${pr} with these labels: ${options.labels.join(', ')}`)
+}
+
+main()

.github/actions-scripts/projects.js

@@ -59,7 +59,7 @@ export async function addItemsToProject(items, project) {
   `
 
   const newItems = await graphql(mutation, {
-    project: project,
+    project,
     headers: {
       authorization: `token ${process.env.TOKEN}`,
       'GraphQL-Features': 'projects_next_graphql',
@@ -221,40 +221,40 @@ export function generateUpdateProjectNextItemFieldMutation({
       $authorID: ID!
     ) {
       ${generateMutationToUpdateField({
-        item: item,
+        item,
         fieldID: '$statusID',
         value: '$statusValueID',
       })}
       ${generateMutationToUpdateField({
-        item: item,
+        item,
         fieldID: '$datePostedID',
         value: formatDateForProject(datePosted),
         literal: true,
       })}
       ${generateMutationToUpdateField({
-        item: item,
+        item,
         fieldID: '$reviewDueDateID',
         value: formatDateForProject(dueDate),
         literal: true,
       })}
       ${generateMutationToUpdateField({
-        item: item,
+        item,
         fieldID: '$contributorTypeID',
         value: '$contributorType',
       })}
       ${generateMutationToUpdateField({
-        item: item,
+        item,
         fieldID: '$sizeTypeID',
         value: '$sizeType',
       })}
       ${generateMutationToUpdateField({
-        item: item,
+        item,
         fieldID: '$featureID',
         value: feature,
         literal: true,
       })}
       ${generateMutationToUpdateField({
-        item: item,
+        item,
         fieldID: '$authorID',
         value: author,
         literal: true,