Merge branch 'main' into yaananth-patch-1

Author: saritai

.devcontainer/devcontainer.json

@@ -33,4 +33,5 @@
 
 	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
 	"remoteUser": "node"
+
 }

.eslintrc.js

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

.github/CODEOWNERS

@@ -10,6 +10,7 @@
 /.github/ @github/docs-engineering
 /script/ @github/docs-engineering
 /includes/ @github/docs-engineering
+/lib/search/popular-pages.json @github/docs-engineering
 app.json @github/docs-engineering
 Dockerfile @github/docs-engineering
 package-lock.json @github/docs-engineering
@@ -19,8 +20,8 @@ package.json @github/docs-engineering
 /.github/workflows/create-translation-batch-pr.yml @github/docs-localization
 /.github/workflows/crowdin.yml @github/docs-localization
 /crowdin*.yml @github/docs-engineering @github/docs-localization
-/translations/ @github/docs-engineering @github/docs-localization @github-actions
-/translations/log/ @github/docs-localization
+/translations/ @github/docs-engineering @github/docs-localization @Octomerger
+/translations/log/ @github/docs-localization @Octomerger
 
 # Site Policy
 /content/github/site-policy/ @github/site-policy-admins

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

@@ -8,88 +8,83 @@ import {
   generateUpdateProjectNextItemFieldMutation,
 } from './projects.js'
 
-async function run() {
-  // Get info about the docs-content review board project
-  // and about open github/github PRs
-  const data = await graphql(
-    `
-      query ($organization: String!, $repo: String!, $projectNumber: Int!, $num_prs: Int!) {
-        organization(login: $organization) {
-          projectNext(number: $projectNumber) {
-            id
-            items(last: 100) {
+async function getAllOpenPRs() {
+  let prsRemaining = true
+  let cursor
+  let prData = []
+  while (prsRemaining) {
+    const data = await graphql(
+      `
+        query ($organization: String!, $repo: String!) {
+          repository(name: $repo, owner: $organization) {
+            pullRequests(last: 100, states: OPEN${cursor ? ` before:"${cursor}"` : ''}) {
+              pageInfo{startCursor, hasPreviousPage},
               nodes {
                 id
-              }
-            }
-            fields(first: 20) {
-              nodes {
-                id
-                name
-                settings
-              }
-            }
-          }
-        }
-        repository(name: $repo, owner: $organization) {
-          pullRequests(last: $num_prs, states: OPEN) {
-            nodes {
-              id
-              isDraft
-              reviewRequests(first: 10) {
-                nodes {
-                  requestedReviewer {
-                    ... on Team {
-                      name
+                isDraft
+                reviewRequests(first: 10) {
+                  nodes {
+                    requestedReviewer {
+                      ... on Team {
+                        name
+                      }
                     }
                   }
                 }
-              }
-              labels(first: 5) {
-                nodes {
-                  name
+                labels(first: 5) {
+                  nodes {
+                    name
+                  }
                 }
-              }
-              reviews(first: 10) {
-                nodes {
-                  onBehalfOf(first: 1) {
-                    nodes {
-                      name
+                reviews(first: 10) {
+                  nodes {
+                    onBehalfOf(first: 1) {
+                      nodes {
+                        name
+                      }
                     }
                   }
                 }
-              }
-              author {
-                login
+                author {
+                  login
+                }
               }
             }
           }
         }
+      `,
+      {
+        organization: process.env.ORGANIZATION,
+        repo: process.env.REPO,
+        headers: {
+          authorization: `token ${process.env.TOKEN}`,
+        },
       }
-    `,
-    {
-      organization: process.env.ORGANIZATION,
-      repo: process.env.REPO,
-      projectNumber: parseInt(process.env.PROJECT_NUMBER),
-      num_prs: parseInt(process.env.NUM_PRS),
-      headers: {
-        authorization: `token ${process.env.TOKEN}`,
-        'GraphQL-Features': 'projects_next_graphql',
-      },
-    }
-  )
+    )
+
+    prsRemaining = data.repository.pullRequests.pageInfo.hasPreviousPage
+    cursor = data.repository.pullRequests.pageInfo.startCursor
+    prData = [...prData, ...data.repository.pullRequests.nodes]
+  }
+
+  return prData
+}
+
+async function run() {
+  // Get info about open github/github PRs
+  const prData = await getAllOpenPRs()
 
   // Get the PRs that are:
   // - not draft
   // - not a train
   // - are requesting a review by docs-reviewers
   // - have not already been reviewed on behalf of docs-reviewers
-  const prs = data.repository.pullRequests.nodes.filter(
+  const prs = prData.filter(
     (pr) =>
       !pr.isDraft &&
       !pr.labels.nodes.find((label) => label.name === 'Deploy train 🚂') &&
       pr.reviewRequests.nodes.find(
-        (requestedReviewers) => requestedReviewers.requestedReviewer.name === process.env.REVIEWER
+        (requestedReviewers) => requestedReviewers.requestedReviewer?.name === process.env.REVIEWER
       ) &&
       !pr.reviews.nodes
         .flatMap((review) => review.onBehalfOf.nodes)
@@ -104,28 +99,60 @@ async function run() {
   const prAuthors = prs.map((pr) => pr.author.login)
   console.log(`PRs found: ${prIDs}`)
 
+  // Get info about the docs-content review board project
+  const projectData = await graphql(
+    `
+      query ($organization: String!, $projectNumber: Int!) {
+        organization(login: $organization) {
+          projectNext(number: $projectNumber) {
+            id
+            items(last: 100) {
+              nodes {
+                id
+              }
+            }
+            fields(first: 100) {
+              nodes {
+                id
+                name
+                settings
+              }
+            }
+          }
+        }
+      }
+    `,
+    {
+      organization: process.env.ORGANIZATION,
+      projectNumber: parseInt(process.env.PROJECT_NUMBER),
+      headers: {
+        authorization: `token ${process.env.TOKEN}`,
+      },
+    }
+  )
+
   // Get the project ID
-  const projectID = data.organization.projectNext.id
+  const projectID = projectData.organization.projectNext.id
 
   // Get the IDs of the last 100 items on the board.
   // Until we have a way to check from a PR whether the PR is in a project,
   // this is how we (roughly) avoid overwriting PRs that are already on the board.
   // If we are overwriting items, query for more items.
-  const existingItemIDs = data.organization.projectNext.items.nodes.map((node) => node.id)
+  const existingItemIDs = projectData.organization.projectNext.items.nodes.map((node) => node.id)
 
   // Get the ID of the fields that we want to populate
-  const datePostedID = findFieldID('Date posted', data)
-  const reviewDueDateID = findFieldID('Review due date', data)
-  const statusID = findFieldID('Status', data)
-  const featureID = findFieldID('Feature', data)
-  const contributorTypeID = findFieldID('Contributor type', data)
-  const sizeTypeID = findFieldID('Size', data)
-  const authorID = findFieldID('Contributor', data)
+  const datePostedID = findFieldID('Date posted', projectData)
+  const reviewDueDateID = findFieldID('Review due date', projectData)
+  const statusID = findFieldID('Status', projectData)
+  const featureID = findFieldID('Feature', projectData)
+  const contributorTypeID = findFieldID('Contributor type', projectData)
+  const sizeTypeID = findFieldID('Size', projectData)
+  const authorID = findFieldID('Contributor', projectData)
 
   // Get the ID of the single select values that we want to set
-  const readyForReviewID = findSingleSelectID('Ready for review', 'Status', data)
-  const hubberTypeID = findSingleSelectID('Hubber or partner', 'Contributor type', data)
-  const docsMemberTypeID = findSingleSelectID('Docs team', 'Contributor type', data)
+  const readyForReviewID = findSingleSelectID('Ready for review', 'Status', projectData)
+  const hubberTypeID = findSingleSelectID('Hubber or partner', 'Contributor type', projectData)
+  const docsMemberTypeID = findSingleSelectID('Docs team', 'Contributor type', projectData)
 
   // Add the PRs to the project
   const itemIDs = await addItemsToProject(prIDs, projectID)
@@ -134,8 +161,8 @@ async function run() {
   // Exclude existing items going forward.
   // Until we have a way to check from a PR whether the PR is in a project,
   // this is how we (roughly) avoid overwriting PRs that are already on the board
-  let newItemIDs = []
-  let newItemAuthors = []
+  const newItemIDs = []
+  const newItemAuthors = []
   itemIDs.forEach((id, index) => {
     if (!existingItemIDs.includes(id)) {
       newItemIDs.push(id)

.github/actions-scripts/projects.js

@@ -114,6 +114,29 @@ export async function isDocsTeamMember(login) {
   return teamMembers.includes(login)
 }
 
+// Given a GitHub login, returns a bool indicating
+// whether the login is part of the GitHub org
+export async function isGitHubOrgMember(login) {
+  const data = await graphql(
+    `
+      query {
+        user(login: "${login}") {
+          organization(login: "github"){
+            name
+          }
+        }
+      }
+    `,
+    {
+      headers: {
+        authorization: `token ${process.env.TOKEN}`,
+      },
+    }
+  )
+
+  return Boolean(data.user.organization)
+}
+
 // Formats a date object into the required format for projects
 export function formatDateForProject(date) {
   return date.getFullYear() + '-' + (date.getMonth() + 1) + '-' + date.getDate()
@@ -246,6 +269,7 @@ export default {
   addItemsToProject,
   addItemToProject,
   isDocsTeamMember,
+  isGitHubOrgMember,
   findFieldID,
   findSingleSelectID,
   formatDateForProject,

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

@@ -2,10 +2,4 @@
 
 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
-}
+await purgeEdgeCache()

.github/actions-scripts/ready-for-docs-review.js

@@ -3,6 +3,7 @@ import { graphql } from '@octokit/graphql'
 import {
   addItemToProject,
   isDocsTeamMember,
+  isGitHubOrgMember,
   findFieldID,
   findSingleSelectID,
   generateUpdateProjectNextItemFieldMutation,
@@ -85,8 +86,8 @@ async function run() {
     // - affected docs sets (not considering changes to data/assets)
     let numFiles = 0
     let numChanges = 0
-    let features = new Set([])
-    const files = data.item.files.nodes.forEach((node) => {
+    const features = new Set([])
+    data.item.files.nodes.forEach((node) => {
       numFiles += 1
       numChanges += node.additions
       numChanges += node.deletions
@@ -178,9 +179,12 @@ async function run() {
   let contributorType
   if (await isDocsTeamMember(process.env.AUTHOR_LOGIN)) {
     contributorType = docsMemberTypeID
+  } else if (await isGitHubOrgMember(process.env.AUTHOR_LOGIN)) {
+    contributorType = hubberTypeID
   } else if (process.env.REPO === 'github/docs') {
     contributorType = osContributorTypeID
   } else {
+    // use hubber as the fallback so that the PR doesn't get lost on the board
     contributorType = hubberTypeID
   }
 

.github/actions-scripts/staging-commit-status-success.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+import * as github from '@actions/github'
+
+import getOctokit from '../../script/helpers/github.js'
+
+const { GITHUB_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!')
+}
+
+// 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 { CONTEXT_NAME, ACTIONS_RUN_LOG, HEAD_SHA } = process.env
+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 { context } = github
+const owner = context.repo.owner
+const repo = context.payload.repository.name
+
+await octokit.repos.createCommitStatus({
+  owner,
+  repo,
+  sha: HEAD_SHA,
+  context: CONTEXT_NAME,
+  state: 'success',
+  description: 'Successfully deployed! See logs.',
+  target_url: ACTIONS_RUN_LOG,
+})