Merge pull request #2057 from acterglobal/ben-simplified-docs

Fix Docs generation

.github/workflows/docs.yml → .github/workflows/build-docs.yml

@@ -1,27 +1,14 @@
-name: Docs
+name: Reusable Docs Build
 
 on:
-  push:
-    branches:
-      - main
-  pull_request:
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
+  workflow_call:
 
 jobs:
   docs:
     runs-on: ubuntu-20.04
     name: Build Latest API Docs
     steps:
-      - uses: actions/checkout@v3
-        with:
-          submodules: true
-
-      #       ---- setup of systems
-
+      - uses: actions/checkout@v4
       - name: Setup flutter
         uses: subosito/flutter-action@v2
         with:
@@ -52,25 +39,21 @@ jobs:
         run: |
           cargo doc -p acter -p acter-core -p matrix-sdk-store-media-cache-wrapper
           echo --- Moving docs
-          mv target/doc/ docs/static/api/main/rust
+          mv target/doc/ docs/api/main/rust
 
       - name: Build Dart App
-        run: flutter pub global run dartdoc  --include-external integration_test/main_test.dart --output ../docs/static/api/main/app/
+        run: flutter pub global run dartdoc  --include-external integration_test/main_test.dart --output ../docs/api/main/app/
         working-directory: app
 
       - name: Checking for bindings
         run: ls -ltas packages/rust_sdk/lib/
 
       - name: Build Dart SDK
-        run: flutter pub global run dartdoc --output ../../../docs/static/api/main/dart-sdk/
+        run: flutter pub global run dartdoc --output ../../../docs/api/main/dart-sdk/
         working-directory: packages/rust_sdk
 
-      #       ---- Finalisation for github pages
-
-      - name: build zola
-        uses: shalzz/[email protected]
-        if: ${{ github.ref == 'refs/heads/main' }}
-        env:
-          BUILD_DIR: docs
-          PAGES_BRANCH: "gh-pages"
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload the docs
+          path: 'docs/'

.github/workflows/check-docs.yml

@@ -0,0 +1,26 @@
+name: Docs
+
+on:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  docs:
+    uses: ./.github/workflows/build-docs.yml
+    secrets: inherit
+
+  deploy:
+    runs-on: ubuntu-20.04
+    if: ${{ github.ref == 'refs/heads/main' }}
+    needs:
+      - docs
+    name: Build Latest API Docs
+    steps:
+      - name: Deploy to GitHub Pages
+        if: ${{ github.ref == 'refs/heads/main' }}
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/demo.yml → .github/workflows/deploy-demo.yml

@@ -1,8 +1,6 @@
 name: Demo builds
 
 on:
-  push:
-    branches: [ main ]
   pull_request:
     branches: [ main ]
 

.github/workflows/deploy-docs.yml

@@ -0,0 +1,37 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+
+  docs:
+    uses: ./.github/workflows/build-docs.yml
+    secrets: inherit
+
+  deploy:
+    runs-on: ubuntu-20.04
+    if: ${{ github.ref == 'refs/heads/main' }}
+    needs:
+      - docs
+    name: Build Latest API Docs
+    steps:
+      - name: Deploy to GitHub Pages
+        if: ${{ github.ref == 'refs/heads/main' }}
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "docs/themes/adidoks"]
-	path = docs/themes/adidoks
-	url = https://github.com/aaranxu/adidoks.git

docs/.gitignore

@@ -1,2 +1,2 @@
-static/api/main/
+api/main/
 public