Merge branch 'main' into patch-2

Author: vgrl

.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)

.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/ready-for-docs-review.js

@@ -3,6 +3,7 @@ import { graphql } from '@octokit/graphql'
 import {
   addItemToProject,
   isDocsTeamMember,
+  isGitHubOrgMember,
   findFieldID,
   findSingleSelectID,
   generateUpdateProjectNextItemFieldMutation,
@@ -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/allowed-actions.js

@@ -31,8 +31,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
-      - uses: github/codeql-action/init@v1
+      - uses: github/codeql-action/init@5f532563584d71fdef14ee64d17bafb34f751ce5
         with:
           languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!)
-      - uses: github/codeql-action/analyze@v1
+      - uses: github/codeql-action/analyze@5f532563584d71fdef14ee64d17bafb34f751ce5
         continue-on-error: true

.github/workflows/codeql.yml

@@ -40,6 +40,3 @@ jobs:
           ORGANIZATION: 'github'
           REPO: 'github'
           REVIEWER: 'docs-reviewers'
-          # This is an educated guess of how many PRs are opened in a day on the github/github repo
-          # If we are missing PRs, either increase this number or increase the frequency at which this script is run
-          NUM_PRS: 100

.github/workflows/docs-review-collect.yml

@@ -5,7 +5,7 @@ name: Hubber contribution help
 # **Who does it impact**: docs-internal contributors
 
 on:
-  pull_request:
+  pull_request_target:
     types:
       - opened
     paths:

.github/workflows/hubber-contribution-help.yml

@@ -46,7 +46,7 @@ jobs:
           output: ' '
       - name: Insight into changed files
         run: |
-          echo ${{ steps.get_diff_files.outputs.files }}
+          echo "${{ steps.get_diff_files.outputs.files }}"
 
       - name: Link check (warnings, changed files)
         run: |
@@ -56,7 +56,7 @@ jobs:
             --check-anchors \
             --check-images \
             --verbose \
-            ${{ steps.get_diff_files.outputs.files }}
+            "${{ steps.get_diff_files.outputs.files }}"
 
       - name: Link check (critical, all files)
         run: |

.github/workflows/link-check-all.yml

@@ -0,0 +1,30 @@
+name: 'Orphaned assets check'
+
+# **What it does**: Checks that there are no files in ./assets/ that aren't mentioned in any source file.
+# **Why we have it**: To avoid orphans into the repo.
+# **Who does it impact**: Docs content.
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579
+
+      - name: Setup node
+        uses: actions/setup-node@04c56d2f954f1e4c69436aa54cfef261a018f458
+        with:
+          node-version: 16.13.x
+          cache: npm
+
+      - name: Install
+        run: npm ci
+
+      - name: Check for orphaned assets
+        run: ./script/find-orphaned-assets.mjs --verbose --exit