feat(docs): fetch docs from monorepository branches

Author: innocenzi

.gitignore

@@ -1,6 +1,7 @@
 .tempest
 node_modules/
 vendor/
+docs-clone/
 /public/main.css
 /package-lock.json
 .env
@@ -18,4 +19,4 @@ tempest-access.log
 vite-tempest
 public/build/
 database.sqlite
-database-old.sqlite
+database-old.sqlite

deploy.sh

@@ -15,6 +15,7 @@ php8.4 tempest migrate:up --force
 php8.4 tempest static:clean --force
 
 # Build front-end
+php8.4 tempest docs:pull --no-interaction
 php8.4 tempest command-palette:index
 /home/forge/.bun/bin/bun run build
 php8.4 tempest cache:clear --force

src/Web/Documentation/.gitignore

@@ -0,0 +1 @@
+content/*

src/Web/Documentation/PullDocumentationCommand.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace App\Web\Documentation;
+
+use RuntimeException;
+use Symfony\Component\Process\Process;
+use Tempest\Console\Console;
+use Tempest\Console\ConsoleCommand;
+use Tempest\Support\Filesystem;
+
+use function Tempest\root_path;
+use function Tempest\Support\path;
+
+final class PullDocumentationCommand
+{
+    private const CLONE_DIRECTORY = 'clone';
+    private const DOCS_DIRECTORY = 'docs';
+
+    public function __construct(
+        private readonly Console $console,
+    ) {}
+
+    #[ConsoleCommand('docs:pull')]
+    public function __invoke(?Version $version = null)
+    {
+        $versions = $version ? [$version] : Version::cases();
+
+        $this->console->header('Cloning documentation');
+
+        foreach ($versions as $version) {
+            $this->console->task(
+                label: "Fetching {$version->getBranch()}",
+                handler: fn () => $this->fetchVersionDocumentation($version),
+            );
+        }
+
+        $this->console->writeln();
+        $this->console->success('Documentation fetched successfully.');
+    }
+
+    private function fetchVersionDocumentation(Version $version): void
+    {
+        $versionedDocsDirectory = root_path('src/Web/Documentation/content/', $version->getUrlSegment());
+        $temporaryDirectory = root_path('docs-clone');
+
+        Filesystem\ensure_directory_empty($versionedDocsDirectory);
+        Filesystem\ensure_directory_empty($temporaryDirectory);
+
+        $this->run(
+            command: sprintf(
+                'git clone --no-checkout --depth=1 --filter=tree:0 -b %s https://github.com/tempestphp/tempest-framework %s',
+                $version->getBranch(),
+                self::CLONE_DIRECTORY,
+            ),
+            cwd: $temporaryDirectory,
+        );
+
+        $this->run(
+            command: 'git sparse-checkout set --no-cone /' . self::DOCS_DIRECTORY,
+            cwd: path($temporaryDirectory, self::CLONE_DIRECTORY),
+        );
+
+        $this->run(
+            command: 'git checkout',
+            cwd: path($temporaryDirectory, self::CLONE_DIRECTORY),
+        );
+
+        Filesystem\move(path($temporaryDirectory, self::CLONE_DIRECTORY, self::DOCS_DIRECTORY), $versionedDocsDirectory, overwrite: true);
+        Filesystem\delete_directory($temporaryDirectory);
+    }
+
+    private function run(string $command, string $cwd): string
+    {
+        $process = Process::fromShellCommandline($command, $cwd);
+        $process->run();
+
+        if (! $process->isSuccessful()) {
+            throw new RuntimeException($process->getErrorOutput());
+        }
+
+        return $process->getOutput();
+    }
+}

src/Web/Documentation/Version.php

@@ -8,11 +8,23 @@ enum Version: string
 {
     use IsEnumHelper;
 
-    case VERSION_1 = '1.x';
+    case VERSION_1 = 'main';
+    case VERSION_2 = '2.x';
 
-    public static function default(): self
+    public function getBranch(): string
     {
-        return self::VERSION_1;
+        return match ($this) {
+            self::VERSION_1 => 'main',
+            self::VERSION_2 => '2.x',
+        };
+    }
+
+    public function getUrlSegment(): string
+    {
+        return match ($this) {
+            self::VERSION_1 => 'main',
+            self::VERSION_2 => '2.x',
+        };
     }
 
     public static function tryFromString(?string $case): ?static
@@ -22,4 +34,9 @@ public static function tryFromString(?string $case): ?static
             default => self::tryFrom($case),
         };
     }
+
+    public static function default(): self
+    {
+        return self::VERSION_1;
+    }
 }