Add ignore-not-found option for feature-flagged docs URLs (#56273)

Author: heiskr

.github/workflows/validate-github-github-docs-urls.yml

@@ -50,6 +50,7 @@ jobs:
           # do other things in other steps.
           npm run validate-github-github-docs-urls -- validate \
             --output checks.json \
+            --ignore-not-found \
             github/config/docs-urls.json
 
       - name: Update config/docs-urls.json in github/github (possibly)

src/links/scripts/validate-github-github-docs-urls/index.ts

@@ -13,6 +13,10 @@ program
   .description('Validate config/docs-urls.json in github/github')
   .option('--fail-on-warning', 'Any warning will make the process exit with a non-zero code')
   .option('--fail-on-error', 'Any error will make the process exit with a non-zero code')
+  .option(
+    '--ignore-not-found',
+    'Do not fail validation on 404 errors (pages not found) - useful for feature-flagged content',
+  )
   .option('-o, --output <output-file>', 'Output file')
   .argument('<docs-urls-json-filepath>', 'path to the docs-urls JSON file')
   .action(validate)

src/links/scripts/validate-github-github-docs-urls/validate.ts

@@ -7,6 +7,7 @@ type Options = {
   failOnWarning?: boolean
   failOnError?: boolean
   output?: string
+  ignoreNotFound?: boolean
 }
 
 export async function validate(filePath: string, options: Options) {
@@ -26,8 +27,13 @@ export async function validate(filePath: string, options: Options) {
         console.log(prefix, `✅ ${check.url} (${check.identifier})`)
       }
     } else {
-      if (options.failOnError) exitCode++
-      console.log(prefix, `❌ ${check.url} (${check.identifier})`)
+      // This is a 404 - page not found
+      if (options.ignoreNotFound) {
+        console.log(prefix, `⚠️  ${check.url} (${check.identifier})`)
+      } else {
+        if (options.failOnError) exitCode++
+        console.log(prefix, `❌ ${check.url} (${check.identifier})`)
+      }
     }
     if (check.fragment) {
       if (check.fragmentFound) {
@@ -58,7 +64,16 @@ export async function validate(filePath: string, options: Options) {
     chalk.yellow(T('Redirects')),
     checks.filter((check) => check.found && check.redirect).length,
   )
-  console.log(chalk.red(T('Failures')), checks.filter((check) => !check.found).length)
+  const notFoundChecks = checks.filter((check) => !check.found)
+
+  if (options.ignoreNotFound) {
+    console.log(chalk.red(T('Failures')), 0)
+    if (notFoundChecks.length > 0) {
+      console.log(chalk.yellow(T('Ignored (404s)')), notFoundChecks.length)
+    }
+  } else {
+    console.log(chalk.red(T('Failures')), notFoundChecks.length)
+  }
   console.log(
     chalk.red(T('Failing fragments')),
     checks.filter((check) => check.found && check.fragment && !check.fragmentFound).length,