Documentation Website

.github/workflows/check.build.docs.yml

@@ -0,0 +1,79 @@
+name: Check Build Documentation Site
+
+on:
+  pull_request:
+
+    paths:
+      - "docs/website-src/**"
+
+  workflow_dispatch:
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      #- name: LikeC4 code generation
+      #  uses: likec4/actions@v1
+      #  with:
+      #    codegen: react
+      #    path: website/likec4_src
+      #    output: website/likec4_react/likec4.generated.js
+
+      #- name: LikeC4 PNG export
+      #  uses: likec4/actions@v1
+      #  with:
+      #    export: png
+      #    path: website/likec4_src
+      #    output: website/public/images/likec4
+
+      - name: Detect package manager
+        id: detect-package-manager
+        run: |
+          if [ -f "docs/website-src/yarn.lock" ]; then
+            echo "manager=yarn" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=yarn" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "docs/website-src/package.json" ]; then
+            echo "manager=npm" >> $GITHUB_OUTPUT
+            echo "command=ci" >> $GITHUB_OUTPUT
+            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
+            exit 0
+          else
+            echo "Unable to determine package manager"
+            exit 1
+          fi
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Restore cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            docs/website-src/.next/cache
+          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
+          restore-keys: |
+            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
+
+      - name: Install dependencies
+        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
+        working-directory: docs/website-src
+
+      - name: Build with Next.js
+        run: ${{ steps.detect-package-manager.outputs.runner }} next build
+        working-directory: docs/website-src
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/website-src/out

.github/workflows/deploy.docs.yml

@@ -0,0 +1,104 @@
+name: Deploy Documentation Site to GitHub Pages
+
+on:
+  push:
+    branches:
+      - documentation
+
+    paths:
+      - "docs/website-src/**"
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      #- name: LikeC4 code generation
+      #  uses: likec4/actions@v1
+      #  with:
+      #    codegen: react
+      #    path: website/likec4_src
+      #    output: website/likec4_react/likec4.generated.js
+
+      #- name: LikeC4 PNG export
+      #  uses: likec4/actions@v1
+      #  with:
+      #    export: png
+      #    path: website/likec4_src
+      #    output: website/public/images/likec4
+
+      - name: Detect package manager
+        id: detect-package-manager
+        run: |
+          if [ -f "docs/website-src/yarn.lock" ]; then
+            echo "manager=yarn" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=yarn" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "docs/website-src/package.json" ]; then
+            echo "manager=npm" >> $GITHUB_OUTPUT
+            echo "command=ci" >> $GITHUB_OUTPUT
+            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
+            exit 0
+          else
+            echo "Unable to determine package manager"
+            exit 1
+          fi
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Restore cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            .next/cache
+          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
+          restore-keys: |
+            ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
+
+      - name: Install dependencies
+        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
+        working-directory: website
+
+      - name: Build with Next.js
+        run: ${{ steps.detect-package-manager.outputs.runner }} next build
+        working-directory: website
+
+      - name: Copy built files to docs
+        run: |
+          rm -rf docs/website/*
+          cp -r docs/website-src/out docs/website
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/website
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/test_docker.yml

@@ -3,6 +3,11 @@ name: Integration Tests
 on:
   pull_request:
     branches: [ develop ]
+    paths:
+      - "app/**"
+      - "tests/**"
+
+  workflow_dispatch:
 
 jobs:
   test:

.github/workflows/unit_tests.yml

@@ -3,6 +3,11 @@ name: Unit Tests
 on:
   pull_request:
     branches: [ develop ]
+    paths:
+      - "app/**"
+      - "tests/**"
+
+  workflow_dispatch:
 
 jobs:
   test:

docs/website-src/next.config.mjs

@@ -0,0 +1,20 @@
+/** @type {import('next').NextConfig} */
+import nextra from "nextra";
+
+const nextConfig = {
+  reactStrictMode: true,
+  images: {
+    unoptimized: true,
+  },
+  distDir: "out",
+  output: "export",
+  basePath: "",
+  assetPrefix: "",
+};
+
+const withNextra = nextra({
+  theme: "nextra-theme-docs",
+  themeConfig: "./theme.config.tsx",
+});
+
+export default withNextra(nextConfig);