now fetches old docs without building

JaylyDev · JaylyDev · commit 93e31b22fbab · 2023-05-06T10:26:38.000+01:00
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -30,6 +30,8 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_branch: gh-pages  # default: gh-pages
           publish_dir: ./docs/.vuepress/dist
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
 
       - name: Upload Docs
         uses: EndBug/add-and-commit@v9
diff --git a/README.md b/README.md
@@ -4,5 +4,5 @@ Landing page containing documentation of experimental and stable Script APIs for
 
 ## Documentation
 
-For more detailed documentation, the changelog, and How-To Guide provided by Microsoft, see https://learn.microsoft.com/minecraft/creator/scriptapi/.
+For more detailed documentation, the changelog, and How-To Guide provided by Microsoft, see [Script API Documentation Homepage | Microsoft Learn](https://learn.microsoft.com/minecraft/creator/scriptapi/).
 
diff --git a/src/fetchOldDocs.ts b/src/fetchOldDocs.ts
@@ -0,0 +1,25 @@
+import { execSync } from "child_process";
+import * as fs from "fs-extra";
+import path = require("path");
+
+const tempBranchDir = ".temp/scriptapi-docs";
+const gitUrl = "https://github.com/jaylydev/scriptapi-docs.git";
+const branch = "gh-pages";
+
+export function copyOldDocumentation () {
+  execSync(`git clone --depth 1 --single-branch --branch ${branch} ${gitUrl} ${tempBranchDir}`);
+  const folders = fs.readdirSync(path.resolve(tempBranchDir)).filter(f => f.startsWith("1.") && fs.statSync(path.resolve(tempBranchDir, f)).isDirectory());
+  folders.forEach(folder => {
+    // Copy each folder to the dist folder
+    fs.copySync(
+      path.resolve(tempBranchDir, folder),
+      path.resolve("./docs/.vuepress/dist", folder)
+    );
+  });
+
+  console.log("Successfully copied existing documentation to ./docs/.vuepress/dist");
+
+  // Remove the cloned directory
+  fs.rmdirSync(tempBranchDir, { recursive: true });
+  console.log("Successfully removed cloned directory.");
+};
diff --git a/src/index.ts b/src/index.ts
@@ -3,6 +3,8 @@ import { execSync } from "child_process";
 import * as dotenv from "dotenv";
 import { generateDocsIndexPage } from "./indexPage";
 import { PackageMetadata, installBundle, installModule } from "./installModules";
+import * as fs from "fs-extra";
+import { copyOldDocumentation } from "./fetchOldDocs";
 
 dotenv.config();
 
@@ -17,7 +19,7 @@ const scriptModules = [
 
 const bundleModules = [
   "@minecraft/vanilla-data",
-]
+];
 
 console.log("Generating documentation for version " + version + "...");
 
@@ -38,6 +40,11 @@ console.log("Generating documentation for version " + version + "...");
   execSync("npm run docs:build");
   console.log("Successfully built docs at ./docs/.vuepress/dist");
 
+  // Pull existing documentation hosted on GitHub, to reduce build time.
+  copyOldDocumentation();
+  console.log("Successfully copied previous documentation at ./docs/.vuepress/dist");
+
+  // Generate docs for version requested
   execSync("typedoc");
   console.log("Successfully ran typedoc. Documentation are generated in ./docs/.vuepress/dist/" + version);
 })();

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@ Landing page containing documentation of experimental and stable Script APIs for`
`4`	`4`
`5`	`5`	`## Documentation`
`6`	`6`
`7`		`-For more detailed documentation, the changelog, and How-To Guide provided by Microsoft, see https://learn.microsoft.com/minecraft/creator/scriptapi/.`
	`7`	`+For more detailed documentation, the changelog, and How-To Guide provided by Microsoft, see [Script API Documentation Homepage \| Microsoft Learn](https://learn.microsoft.com/minecraft/creator/scriptapi/).`
`8`	`8`