refactor: Dynamic docs upload configuration

Author: d3xter666

.github/workflows/deploy-docs-next.yaml …hub/workflows/deploy-vitepress-docs.yaml.github/workflows/deploy-docs-next.yaml renamed to .github/workflows/deploy-vitepress-docs.yaml .github/workflows/deploy-docs-next.yaml renamed to .github/workflows/deploy-vitepress-docs.yaml

@@ -1,6 +1,5 @@
 # Sample workflow for building and deploying a VitePress site to GitHub Pages
-#
-name: Deploy VitePress site to Pages (next)
+name: Deploy VitePress site to gh-pages
 
 on:
     # Runs on pushes targeting the `main` branch. Change this to `master` if you're
@@ -60,7 +59,14 @@ jobs:
             - name: Build jsdoc
               run: npm run jsdoc-generate
             - name: Build vitepress build
-              run: npm run docs:build
+              run: |
+                cd packages/documentation
+                # The base output
+                npm run build:vitepress -- --base="/${{ github.event.repository.name }}/${DOC_VERSION}/"
+                npm run build:assets -- ./dist
+                # The alias output
+                npm run build:vitepress -- --base="/${{ github.event.repository.name }}/${DOC_ALIAS}/" --outDir="dist-${DOC_ALIAS}"
+                npm run build:assets -- ./dist-${DOC_ALIAS}
             - name: Build Schema
               run: |
                   npm run schema-generate
@@ -74,16 +80,19 @@ jobs:
               run: |
                   rm -rf ./gh-pages/schema
                   cp -R ./site/schema ./gh-pages/
-                  rm -rf ./gh-pages/${DOC_VERSION}/
+                  rm -rf ./gh-pages/${DOC_VERSION}
+                  rm -rf ./gh-pages/${DOC_ALIAS}
+
+                  # Main version route
                   cp -R ./packages/documentation/dist ./gh-pages/${DOC_VERSION}/
+                  cp -R ./site/api ./gh-pages/${DOC_VERSION}/api
+
+                  # Alias route. E.g., next, latest, stable, etc.
+                  # For vitepress must be a copy with different config, not a symlink
+                  cp -R ./packages/documentation/dist-${DOC_ALIAS} ./gh-pages/${DOC_ALIAS}/
+                  cp -R ./site/api ./gh-pages/${DOC_ALIAS}/api
+
                   cp ./scripts/resources/custom404.html ./gh-pages/404.html
-            - name: Create or update alias route
-              run: |
-                  cd ./gh-pages
-                  # Remove existing alias if it exists (file or symlink)
-                  rm -rf "${DOC_ALIAS}"
-                  # Create symlink from alias to version directory
-                  ln -s "${DOC_VERSION}" "${DOC_ALIAS}"
             - name: Publish Docs
               run: |
                   cd ./gh-pages

package-lock.json

@@ -29,9 +29,6 @@
 		"coverage": "npm run coverage --workspaces",
 		"jsdoc": "npm run jsdoc-generate && open-cli site/api/index.html",
 		"jsdoc-generate": "jsdoc -c ./jsdoc-workspace.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
-		"docs:dev": "npm --prefix packages/documentation run dev",
-		"docs:build": "npm --prefix packages/documentation run build",
-		"docs:preview": "npm --prefix packages/documentation run preview",
 		"schema-generate": "node ./scripts/buildSchema.js ui5",
 		"schema-workspace-generate": "node ./scripts/buildSchema.js ui5-workspace",
 		"generate-cli-doc": "node ./scripts/generateCliDoc.js",

package.json

@@ -7,7 +7,8 @@ import MarkdownItImplicitFigures from "markdown-it-implicit-figures";
 
 export default defineConfig({
 
-  base: "/cli/v5/", // GitHub Pages deployment base path
+  // Would be set in CI job via CLI arguments. For local development, it's just root.
+  base: "/",
   srcDir: "docs",
   outDir: "dist",
   lang: "en-US",
@@ -274,7 +275,7 @@ function guide() {
     },
     {
       text: "API Reference",
-      link: "https://ui5.github.io/cli/api/index.html",
+      link: "./api/index.html",
 
     },
 

packages/documentation/.vitepress/config.ts

@@ -10,7 +10,7 @@ import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vu
 const { isDark } = useData()
 </script>
 
-<img :src="isDark ? '/cli/v5/images/O_UI5_H_noBG.png' : '/cli/v5/images/UI5_logo_wide.png'" alt="UI5 logo" style="max-width: 100%; height: auto;">
+<img :src="isDark ? './images/O_UI5_H_noBG.png' : './images/UI5_logo_wide.png'" alt="UI5 logo" style="max-width: 100%; height: auto;">
 
 # UI5 CLI
 

packages/documentation/docs/index.md

@@ -24,7 +24,8 @@
 	"scripts": {
 		"start": "vitepress dev --open",
 		"dev": "vitepress dev",
-		"build": "vitepress build && cp -r ./docs/images ./dist/images",
+		"build:vitepress": "vitepress build",
+		"build:assets": "sh -c 'DEST_DIR=${1:-./dist}; cp -r ./docs/images \"$DEST_DIR/images\"' --",
 		"preview": "vitepress preview --port 8080",
 		"serve-docs": "npm run build && npm run preview"
 	},