External link checker: Add an HTTP header for the auth for GitHub

.github/workflows/weekly-checks.yml

@@ -53,6 +53,8 @@ jobs:
       - name: Install Node.js dependencies
         run: npm ci
       - name: Check external links
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
         run: >
           npm run check:external-links --
           'docs/**/*.{md,mdx,ipynb}'

scripts/lib/links/ExternalLink.ts

@@ -37,7 +37,7 @@ export class ExternalLink {
     let error: string = "";
     try {
       const response = await fetch(this.value, {
-        headers: { "User-Agent": "qiskit-documentation-broken-links-finder" },
+        headers: getHeaders(this.value),
         method: "HEAD",
       });
       if (response.status >= 300) {
@@ -57,3 +57,16 @@ export class ExternalLink {
     return `❌ ${error}. Appears in:\n${fileList.join("\n")}`;
   }
 }
+
+function getHeaders(link: string) {
+  const headers: HeadersInit = {
+    "User-Agent": "qiskit-documentation-broken-links-finder",
+  };
+
+  if (link.startsWith("https://github.com")) {
+    const ghToken = process.env.GITHUB_TOKEN;
+    headers["Authorization"] = ghToken ? `token ${ghToken}` : "";
+  }
+
+  return headers;
+}