Fix expired content flagging by including warnings in weekly lint reports (#56303)

Author: heiskr

.github/workflows/lint-entire-content-data-markdown.yml

@@ -1,6 +1,6 @@
 name: 'Lint entire content and data markdown files'
 
-# **What it does**: Lints our content markdown weekly to ensure the content matches the specified styleguide. If errors exists, it opens a PR for the Docs content team to review.
+# **What it does**: Lints our content markdown weekly to ensure the content matches the specified styleguide. If errors or warnings exist, it opens an issue for the Docs content team to review.
 # **Why we have it**: Extra precaution to run linter on the entire content/data directories.
 # **Who does it impact**: Docs content.
 
@@ -32,7 +32,7 @@ jobs:
         id: linting-content-data
         timeout-minutes: 10
         continue-on-error: true
-        run: npm run lint-content -- --errors-only --paths content data --output-file /tmp/error-lints.json
+        run: npm run lint-content -- --paths content data --output-file /tmp/lint-results.json
 
       - name: Open issue in docs-content
         if: ${{ always() && steps.linting-content-data.outcome == 'failure' }}
@@ -41,7 +41,7 @@ jobs:
           REPORT_AUTHOR: docs-bot
           REPORT_LABEL: broken content markdown report
           REPORT_REPOSITORY: github/docs-content
-        run: npm run post-lints -- --path /tmp/error-lints.json
+        run: npm run post-lints -- --path /tmp/lint-results.json
 
       - uses: ./.github/actions/slack-alert
         if: ${{ failure() && github.event_name != 'workflow_dispatch' }}

src/content-linter/scripts/post-lints.js

@@ -12,7 +12,7 @@ import { createReportIssue, linkReports } from '#src/workflows/issue-report.js'
 // the entire content and data directories based on our
 // markdownlint.js rules.
 //
-// If errors are found, it will open up a new issue in the
+// If errors or warnings are found, it will open up a new issue in the
 // docs-content repo with the label "broken content markdown report".
 //
 // The Content FR will go through the issue and update the content and
@@ -21,18 +21,20 @@ import { createReportIssue, linkReports } from '#src/workflows/issue-report.js'
 // [end-readme]
 
 program
-  .description('Opens an issue for Content FR with the errors from the weekly content/data linter.')
+  .description(
+    'Opens an issue for Content FR with the errors and warnings from the weekly content/data linter.',
+  )
   .option(
     '-p, --path <path>',
-    'provide a path to the errors output json file that will be in the issue body',
+    'provide a path to the errors and warnings output json file that will be in the issue body',
   )
   .parse(process.argv)
 
 const { path } = program.opts()
 
 main()
 async function main() {
-  const errors = fs.readFileSync(`${path}`, 'utf8')
+  const lintResults = fs.readFileSync(`${path}`, 'utf8')
   const core = coreLib
   const { REPORT_REPOSITORY, REPORT_AUTHOR, REPORT_LABEL } = process.env
 
@@ -41,18 +43,18 @@ async function main() {
   // or open an issue report, you might get cryptic error messages from Octokit.
   getEnvInputs(['GITHUB_TOKEN'])
 
-  core.info(`Creating issue for errors...`)
+  core.info(`Creating issue for errors and warnings...`)
 
   let reportBody = 'The following files have markdown lint warnings/errors:\n\n'
-  for (const [file, flaws] of Object.entries(JSON.parse(errors))) {
+  for (const [file, flaws] of Object.entries(JSON.parse(lintResults))) {
     reportBody += `File: \`${file}\`:\n`
     reportBody += `\`\`\`json\n${JSON.stringify(flaws, null, 2)}\n\`\`\`\n`
   }
 
   const reportProps = {
     core,
     octokit,
-    reportTitle: `Error(s) in content markdown file(s)`,
+    reportTitle: `Error(s) and warning(s) in content markdown file(s)`,
     reportBody,
     reportRepository: REPORT_REPOSITORY,
     reportLabel: REPORT_LABEL,