From 40ed3a3bd1161eaacd5a3b99c6ec2bd67df40f12 Mon Sep 17 00:00:00 2001
From: Niko <nikoshell2.0@gmail.com>
Date: Tue, 2 Jan 2024 17:28:13 +0100
Subject: [PATCH] [Docs] Add Docs to GH workflows (#1980)

* Add Docs to GH workflows

* Exclude docs/ from Docker build
---
 .github/workflows/docker.yml   |  6 ++++-
 .github/workflows/docs.yml     | 42 ++++++++++++++++++++++++++++++++++
 .github/workflows/lock.yml     |  3 +++
 .github/workflows/releases.yml |  3 +++
 .github/workflows/tests.yml    |  3 +++
 docs/requirements.txt          |  4 ++++
 6 files changed, 60 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/docs.yml

diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
index d6bbb3150..36ddf316f 100644
--- a/.github/workflows/docker.yml
+++ b/.github/workflows/docker.yml
@@ -1,5 +1,9 @@
 name: Docker build
-on: [pull_request]
+on: 
+  pull_request:
+    paths:
+      - '!mkdocs.yml'
+      - '!docs/**'
 
 jobs:
   docker:
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 000000000..bfa836725
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,42 @@
+name: Docs
+on: [push, pull_request, workflow_dispatch]
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  build:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.1.1
+      - uses: actions/setup-python@v5.0.0
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v3.3.2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install -r docs/requirements.txt
+      - run: mkdocs build
+
+  deploy:
+    if: github.event_name == 'push' && contains(fromJson('["refs/heads/dev"]'), github.ref)
+    needs: build
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.1.1
+        with:
+          fetch-depth: '0'
+      - uses: actions/setup-python@v5.0.0
+        with:
+          python-version: 3.x
+      - uses: actions/cache@v3.3.2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: pip install -r docs/requirements.txt
+      - run: mkdocs gh-deploy --force
\ No newline at end of file
diff --git a/.github/workflows/lock.yml b/.github/workflows/lock.yml
index efbf3ae2c..c36b59ad4 100644
--- a/.github/workflows/lock.yml
+++ b/.github/workflows/lock.yml
@@ -3,6 +3,9 @@ on:
   push:
     branches:
       - dev
+    paths:
+      - '!mkdocs.yml'
+      - '!docs/**'
   pull_request:
 
 jobs:
diff --git a/.github/workflows/releases.yml b/.github/workflows/releases.yml
index ebabede76..ef1ce5e3e 100644
--- a/.github/workflows/releases.yml
+++ b/.github/workflows/releases.yml
@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - dev
+    paths:
+      - '!mkdocs.yml'
+      - '!docs/**'      
     tags:
       - '*'
 
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 8eae934a8..6fbf3bf16 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -3,6 +3,9 @@ on:
   push:
     branches:
       - dev
+    paths:
+      - '!mkdocs.yml'
+      - '!docs/**'      
   pull_request:
 
 jobs:
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 1d4b103f0..ab2f44a1d 100755
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -19,3 +19,7 @@ psutil>=3.1.0
 python-ptrace>=0.8
 six
 unicorn>=1.0.0
+mkdocs-material 
+mkdocs-git-committers-plugin-2 
+mkdocs-material-extensions 
+mkdocs-minify-plugin