Adds support to ensure that the repository wiki is added as a git submodule in .github/wiki during the installation of dev-tools scripts.

Signed-off-by: Felipe Sayão Lobato Abreu <github@mentordosnerds.com>

Author: coisa

README.md

@@ -52,7 +52,7 @@ composer dev-tools wiki
 # Generate documentation frontpage and related reports
 composer dev-tools reports
 
-# Installs and synchronizes dev-tools scripts, GitHub Actions workflows, and .editorconfig
+# Installs and synchronizes dev-tools scripts, GitHub Actions workflows, .editorconfig, and ensures the repository wiki is present as a git submodule in .github/wiki
 composer dev-tools install
 ```
 

docs/running/specialized-commands.rst

@@ -76,7 +76,7 @@ Structurally consolidates distinct reporting commands, accurately aggregating te
 8. Install (``install``)
 ------------------------
 
-Adds or updates dev-tools scripts in your ``composer.json``, copies reusable GitHub Actions workflows, and ensures the ``.editorconfig`` file is present and up to date. This command helps standardize your team's workflow and automation setup.
+Adds or updates dev-tools scripts in your ``composer.json``, copies reusable GitHub Actions workflows, ensures the ``.editorconfig`` file is present and up to date, and guarantees the repository wiki is present as a git submodule in ``.github/wiki``. This command helps standardize your team's workflow and automation setup.
 
 .. code-block:: bash
 

src/Command/InstallCommand.php

@@ -24,6 +24,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Filesystem\Path;
 use Symfony\Component\Finder\Finder;
+use Symfony\Component\Process\Process;
 
 /**
  * Represents the command responsible for installing development scripts into `composer.json`.
@@ -69,6 +70,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $this->updateComposerJson();
         $this->createGitHubActionWorkflows();
         $this->copyEditorConfig();
+        $this->addRepositoryWikiGitSubmodule();
 
         return self::SUCCESS;
     }
@@ -164,4 +166,42 @@ private function copyEditorConfig(): void
         $content = $this->filesystem->readFile($source);
         $this->filesystem->dumpFile($target, $content);
     }
+
+    /**
+     * Ensures the repository wiki is added as a git submodule in .github/wiki.
+     *
+     * This method checks if the .github/wiki directory exists. If not, it adds the repository's wiki as a submodule
+     * using the remote origin URL, replacing .git with .wiki.git. This allows automated documentation and wiki updates.
+     *
+     * @return void
+     */
+    private function addRepositoryWikiGitSubmodule(): void
+    {
+        $repositoryUrl = $this->getGitRepositoryUrl();
+
+        $wikiRepoUrl = str_replace('.git', '.wiki.git', $repositoryUrl);
+        $wikiSubmodulePath = $this->getConfigFile('.github/wiki', true);
+
+        if ($this->filesystem->exists($wikiSubmodulePath)) {
+            return;
+        }
+
+        $process = new Process(['git', 'submodule', 'add', $wikiRepoUrl, $wikiSubmodulePath]);
+        $process->mustRun();
+    }
+
+    /**
+     * Retrieves the git remote origin URL for the current repository.
+     *
+     * This method runs 'git config --get remote.origin.url' and returns the trimmed output.
+     *
+     * @return string The remote origin URL of the repository
+     */
+    private function getGitRepositoryUrl(): string
+    {
+        $process = new Process(['git', 'config', '--get', 'remote.origin.url']);
+        $process->mustRun();
+
+        return trim($process->getOutput());
+    }
 }