Merge branch 'main' into patch-9

Author: mchammer01

.dockerignore

@@ -7,8 +7,6 @@ docs/
 node_modules/
 script/
 tests/
-# These files are currently being added by automation in github/github. We will be removing the files permanently when we fix the broken automation in github/github.
-lib/rest/static/dereferenced
 # Folder is cloned during the preview + prod workflows, the assets are merged into other locations for use before the build
 docs-early-access/
 # During the preview deploy untrusted user code may be cloned into this directory

.github/actions-scripts/rendered-content-link-checker.js

@@ -288,6 +288,12 @@ async function main(core, octokit, uploadArtifact, opts = {}) {
         )
       }
     }
+  } else {
+    // It might be that the PR got a comment about >0 flaws before,
+    // and now it can update that comment to say all is well again.
+    if (shouldComment) {
+      await commentOnPR(core, octokit, flaws, opts)
+    }
   }
 }
 
@@ -327,7 +333,7 @@ async function linkReports(core, octokit, newReport, opts) {
 
   const [owner, repo] = reportRepository.split('/')
 
-  core.debug('Attempting to link reports...')
+  core.info('Attempting to link reports...')
   // Find previous broken link report issue
   let previousReports
   try {
@@ -346,7 +352,7 @@ async function linkReports(core, octokit, newReport, opts) {
     core.setFailed('Error listing issues for repo')
     throw error
   }
-  core.debug(`Found ${previousReports.length} previous reports`)
+  core.info(`Found ${previousReports.length} previous reports`)
 
   if (previousReports.length <= 1) {
     core.info('No previous reports to link to')
@@ -422,10 +428,48 @@ async function commentOnPR(core, octokit, flaws, opts) {
     return
   }
 
+  const findAgainSymbol = '<!-- rendered-content-link-checker-comment-finder -->'
+
   const body = flawIssueDisplay(flaws, opts, false)
+
+  const { data } = await octokit.rest.issues.listComments({
+    owner,
+    repo,
+    issue_number: pullNumber,
+  })
+  let previousCommentId
+  for (const { body, id } of data) {
+    if (body.includes(findAgainSymbol)) {
+      previousCommentId = id
+    }
+  }
+
   // Since failed external urls aren't included in PR comment, body may be empty
   if (!body) {
     core.info('No flaws qualify for comment')
+
+    if (previousCommentId) {
+      const nothingComment = 'Previous broken links comment now moot. 👌😙'
+      await octokit.rest.issues.updateComment({
+        owner,
+        repo,
+        comment_id: previousCommentId,
+        body: `${nothingComment}\n\n${findAgainSymbol}`,
+      })
+      core.info(`Updated comment on PR: ${pullNumber} (${previousCommentId})`)
+    }
+    return
+  }
+
+  if (previousCommentId) {
+    const noteComment = '(*The original automated comment was updated*)'
+    await octokit.rest.issues.updateComment({
+      owner,
+      repo,
+      comment_id: previousCommentId,
+      body: `${body}\n\n${noteComment}\n\n${findAgainSymbol}`,
+    })
+    core.info(`Updated comment on PR: ${pullNumber} (${previousCommentId})`)
     return
   }
 
@@ -434,7 +478,7 @@ async function commentOnPR(core, octokit, flaws, opts) {
       owner,
       repo,
       issue_number: pullNumber,
-      body,
+      body: `${body}\n\n${findAgainSymbol}`,
     })
     core.info(`Created comment on PR: ${pullNumber}`)
   } catch (error) {

.github/workflows/first-responder-docs-content.yml

@@ -33,8 +33,6 @@ jobs:
             const repoName = context.payload.repository.name
             const ownerName = context.payload.repository.owner.login
             const issueNumber = (context.eventName === "issues") ? context.payload.issue.number : context.payload.number
-            const labels = (context.eventName === "issues") ? context.payload.issue.labels : context.payload.pull_request.labels
-            const isOpenApiBotLabel = labels.filter(label => label.name === 'github-openapi-bot').length
             const updatedIssueInformation = await github.issues.get({
               owner: ownerName,
               repo: repoName,
@@ -43,13 +41,10 @@ jobs:
             const teamMembers = await github.request(
               `/orgs/github/teams/docs/members?per_page=100`
             )
-            const logins = teamMembers.data.map(member => member.login)
+            const teamLogins = teamMembers.data.map(member => member.login)
             // ignore PRs opened by docs bot accounts
-            logins.push('Octomerger', 'octoglot')
-            // For now, we do want the OpenAPI PRs to show up on the FR
-            // project board because they aren't yet automerged.
-            if (!isOpenApiBotLabel) logins.push('docubot') 
-            if (logins.some(login => login === updatedIssueInformation.data.user.login)) {
+            teamLogins.push('Octomerger', 'octoglot')
+            if (teamLogins.some(login => login === updatedIssueInformation.data.user.login)) {
               console.log(`This issue or pull request was authored by a member of the github/docs team.`)
               return 'true'
             }