Merge pull request #12 from AztecProtocol/feat/broaden-sparse-checkout-paths

feat: broaden sparse checkout paths and add --skip-checks flag

Author: critesjosh

package-lock.json

@@ -53,8 +53,8 @@ const BASE_REPOS: Omit<RepoConfig, "tag">[] = [
           "docs/developer_versioned_docs/version-{version}",
           "docs/static/aztec-nr-api/devnet",
           "docs/static/typescript-api/devnet",
-          "docs/docs-developers/docs/aztec-nr/debugging.md",
-          "docs/docs-operate/operators/operator-faq.md",
+          "docs/docs-developers/docs/aztec-nr",
+          "docs/docs-operate/operators",
         ],
         branch: "next",
       },

src/repos/config.ts

@@ -101,7 +101,7 @@ export async function cloneRepo(
         const repoGit = simpleGit({ baseDir: clonePath, progress: progressHandler });
         await repoGit.raw(["config", "gc.auto", "0"]);
         log?.(`${config.name}: Setting sparse checkout paths: ${config.sparse!.join(", ")}`, "debug");
-        await repoGit.raw(["sparse-checkout", "set", ...config.sparse!]);
+        await repoGit.raw(["sparse-checkout", "set", "--skip-checks", ...config.sparse!]);
         log?.(`${config.name}: Fetching commit ${config.commit.substring(0, 7)}`, "info");
         await repoGit.fetch(["origin", config.commit]);
         log?.(`${config.name}: Checking out commit`, "debug");
@@ -116,7 +116,7 @@ export async function cloneRepo(
         const repoGit = simpleGit({ baseDir: clonePath, progress: progressHandler });
         await repoGit.raw(["config", "gc.auto", "0"]);
         log?.(`${config.name}: Setting sparse checkout paths: ${config.sparse!.join(", ")}`, "debug");
-        await repoGit.raw(["sparse-checkout", "set", ...config.sparse!]);
+        await repoGit.raw(["sparse-checkout", "set", "--skip-checks", ...config.sparse!]);
         log?.(`${config.name}: Fetching tag ${config.tag}`, "info");
         await repoGit.fetch(["--depth=1", "origin", `refs/tags/${config.tag}:refs/tags/${config.tag}`]);
         log?.(`${config.name}: Checking out tag`, "debug");
@@ -132,7 +132,7 @@ export async function cloneRepo(
         const repoGit = simpleGit({ baseDir: clonePath, progress: progressHandler });
         await repoGit.raw(["config", "gc.auto", "0"]);
         log?.(`${config.name}: Setting sparse checkout paths: ${config.sparse!.join(", ")}`, "debug");
-        await repoGit.raw(["sparse-checkout", "set", ...config.sparse!]);
+        await repoGit.raw(["sparse-checkout", "set", "--skip-checks", ...config.sparse!]);
       }
     } else {
       // Clone for smaller repos

src/utils/git.ts

@@ -35,8 +35,8 @@ describe("AZTEC_REPOS", () => {
           `docs/developer_versioned_docs/version-${DEFAULT_AZTEC_VERSION}`,
           "docs/static/aztec-nr-api/devnet",
           "docs/static/typescript-api/devnet",
-          "docs/docs-developers/docs/aztec-nr/debugging.md",
-          "docs/docs-operate/operators/operator-faq.md",
+          "docs/docs-developers/docs/aztec-nr",
+          "docs/docs-operate/operators",
         ],
         branch: "next",
       },

tests/repos/config.test.ts

@@ -138,6 +138,7 @@ describe("cloneRepo", () => {
     expect(mockGitInstance.raw).toHaveBeenCalledWith([
       "sparse-checkout",
       "set",
+      "--skip-checks",
       "docs",
       "noir-projects",
     ]);