Docusaurus versioning

.github/workflows/deploy-docs.yml

@@ -31,8 +31,9 @@ jobs:
         with:
           node-version: "16.x"
 
-        shell: bash
-      - run: yarn build
+      - name: Build 🔧
+        run: yarn install --frozen-lockfile
+        run: yarn build
 
       - name: Deploy 🚀
         uses: JamesIves/[email protected]

custom-version-plugin.js

@@ -0,0 +1,78 @@
+const fs = require('fs');
+const path = require('path');
+
+// Helper function to get all files recursively from a directory
+function getAllFiles(dirPath, arrayOfFiles) {
+  arrayOfFiles = arrayOfFiles || [];
+  const files = fs.readdirSync(dirPath);
+
+  files.forEach(function (file) {
+    const filePath = path.join(dirPath, file);
+    if (fs.statSync(filePath).isDirectory()) {
+      arrayOfFiles = getAllFiles(filePath, arrayOfFiles);
+    } else {
+      arrayOfFiles.push(filePath);
+    }
+  });
+
+  return arrayOfFiles;
+}
+
+function shouldExcludeFile(version, filePath, versionConfig) {
+  const excludedPaths = versionConfig[version]?.excludedPaths || [];
+  return excludedPaths.some((excludedPath) => filePath.startsWith(excludedPath));
+}
+
+module.exports = function (_context, _options) {
+  return {
+    name: 'custom-version-plugin',
+
+    async loadContent() {
+      // Read the versions.json file to get the list of versions
+      const versionsJsonPath = path.join(_context.siteDir, 'versions.json');
+      const versions = JSON.parse(fs.readFileSync(versionsJsonPath, 'utf8'));
+
+      // Read the version config file
+      const versionConfigPath = path.join(_context.siteDir, 'version_config.json');
+      const versionConfig = JSON.parse(fs.readFileSync(versionConfigPath, 'utf8'));
+
+      // Read all the files in the /docs folder
+      const docsPath = path.join(_context.siteDir, 'docs');
+      const files = getAllFiles(docsPath);
+
+      // Iterate through the list of versions
+      for (const version of versions) {
+        const versionedDocsPath = path.join(_context.siteDir, 'versioned_docs', `version-${version}`);
+
+        // Check if the version directory exists
+        if (fs.existsSync(versionedDocsPath)) {
+          // Iterate through the list of files in the /docs folder
+          for (const file of files) {
+            const relativePath = path.relative(docsPath, file);
+            const customFilePath = path.join(versionedDocsPath, relativePath);
+
+            // Check if the file exists in the version directory
+            if (!fs.existsSync(customFilePath) && !shouldExcludeFile(version, relativePath, versionConfig)) {
+              // If the file doesn't exist and it's not excluded, copy it from the /docs folder
+              const customFileDir = path.dirname(customFilePath);
+              fs.mkdirSync(customFileDir, { recursive: true });
+              fs.copyFileSync(file, customFilePath);
+              console.log(`Copied file from /docs to version-${version}:`, relativePath);
+            }
+          }
+
+          // After copying all files, iterate over the versioned directory to remove excluded files
+          const versionedFiles = getAllFiles(versionedDocsPath);
+          for (const file of versionedFiles) {
+            const relativePath = path.relative(versionedDocsPath, file);
+
+            if (shouldExcludeFile(version, relativePath, versionConfig)) {
+              fs.unlinkSync(file);
+              console.log(`Removed excluded file from version-${version}:`, relativePath);
+            }
+          }
+        }
+      }
+    },
+  };
+};

docusaurus.config.js

@@ -13,7 +13,7 @@ const config = {
   tagline:
       "Cosmos SDK is the world's most popular framework for building application-specific blockchains.",
   url: "https://docs.cosmos.network",
-  baseUrl: "/",
+  baseUrl: "/cosmos-sdk-docs",
   onBrokenLinks: "warn",
   onBrokenMarkdownLinks: "warn",
   favicon: "img/favicon.svg",

version_config.json

@@ -0,0 +1,31 @@
+{
+  "0.45": {
+    "excludedPaths": ["integrate/modules/slashing", "integrate/modules/nft", "integrate/building-modules/15-depinject.md", "integrate/modules/genutil",
+      "integrate/modules/consensus", "integrate/modules/circuit", "integrate/building-apps","integrate/building-modules/autocli", "integrate/building-modules/depinject",
+      "integrate/building-modules/testing", "integrate/building-apps", "integrate/architecture/rfc", "integrate/specs", "integrate/architecture/adr-041-in-place-store-migrations", "integrate/architecture/adr-042-group-module",
+      "integrate/architecture/adr-043-nft-module", "integrate/architecture/adr-044-protobuf-updates-guidelines", "integrate/architecture/adr-045-check-delivertx-middlewares",
+      "integrate/architecture/adr-046-module-params", "integrate/architecture/adr-046-module-params", "integrate/architecture/adr-047-extend-upgrade-plan",
+      "integrate/architecture/adr-048-consensus-fees", "integrate/architecture/adr-049-state-sync-hooks", "integrate/architecture/adr-050-sign-mode-textual",
+      "integrate/architecture/adr-050-sign-mode-textual-annex1", "integrate/architecture/adr-050-sign-mode-textual-annex2", "integrate/architecture/adr-053-go-module-refactoring","integrate/architecture/adr-054-semver-compatible-modules",
+      "integrate/architecture/adr-055-orm", "integrate/architecture/adr-057-app-wiring", "integrate/architecture/adr-058-auto-generated-cli", "integrate/architecture/adr-059-test-scopes",
+      "integrate/architecture/adr-060-abci-1.0", "integrate/architecture/adr-061-liquid-staking", "integrate/architecture/adr-062-collections-state-layer",
+      "integrate/architecture/adr-062-collections-state-layer", "integrate/architecture/adr-063-core-module-api", "integrate/architecture/adr-064-abci-2.0",
+      "integrate/architecture/adr-065-store-v2", "integrate/architecture/README"]
+  },
+  "0.46": {
+    "excludedPaths": ["integrate/modules/genutil", "integrate/building-modules/15-depinject.md","integrate/modules/consensus", "integrate/modules/circuit", "integrate/architecture/rfc",
+      "integrate/specs", "integrate/building-apps", "integrate/building-modules/depinject", "integrate/architecture/adr-007-specialization-groups",
+      "integrate/architecture/adr-008-dCERT-group", "integrate/architecture/adr-014-proportional-slashing",
+      "integrate/architecture/adr-034-account-keying", "integrate/architecture/adr-041-in-place-store-migrations", "integrate/architecture/adr-042-group-module",
+      "integrate/architecture/adr-043-nft-module", "integrate/architecture/adr-044-protobuf-updates-guidelines", "integrate/architecture/adr-045-check-delivertx-middlewares",
+      "integrate/architecture/adr-048-consensus-fees", "integrate/architecture/adr-049-state-sync-hooks", "integrate/architecture/adr-050-sign-mode-textual",
+      "integrate/architecture/adr-050-sign-mode-textual-annex1", "integrate/architecture/adr-050-sign-mode-textual-annex2", "integrate/architecture/adr-054-semver-compatible-modules",
+      "integrate/architecture/adr-055-orm", "integrate/architecture/adr-057-app-wiring", "integrate/architecture/adr-058-auto-generated-cli", "integrate/architecture/adr-059-test-scopes",
+      "integrate/architecture/adr-060-abci-1.0", "integrate/architecture/adr-061-liquid-staking", "integrate/architecture/adr-062-collections-state-layer",
+      "integrate/architecture/adr-062-collections-state-layer", "integrate/architecture/adr-063-core-module-api", "integrate/architecture/adr-064-abci-2.0",
+      "integrate/architecture/adr-065-store-v2", "integrate/architecture/README"]
+  },
+  "0.47": {
+    "excludedPaths": []
+  }
+}

versioned_docs/version-0.45/integrate/ibc/README.md

@@ -0,0 +1,20 @@
+<!--
+order: false
+parent:
+  order: 5
+-->
+
+# IBC
+
+This repository contains reference documentation for the IBC protocol integration and concepts:
+
+1. [Overview](overview.md)
+2. [Integration](integration.md)
+3. [Customization](custom.md)
+4. [Relayer](relayer.md)
+5. [Governance Proposals](proposals.md)
+
+**NOTE**: The IBC module has been moved to its [own repository](https://github.com/cosmos/ibc-go).
+
+After reading about IBC, head on to the [Building Modules
+documentation](../building-modules/) to learn more about the process of building modules.