From e20c47d66624ee7bb3978c82e76e651ad4a032d5 Mon Sep 17 00:00:00 2001
From: Din Music <din.music@din-cloud.com>
Date: Thu, 2 Jun 2022 08:03:19 +0200
Subject: [PATCH] Update documentation gh actions

---
 .github/workflows/documentation.yml | 52 ++++++++++++++++++++++++++---
 1 file changed, 47 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
index e3f90d70..9373641a 100644
--- a/.github/workflows/documentation.yml
+++ b/.github/workflows/documentation.yml
@@ -2,18 +2,58 @@ name: documentation
 on:
   push:
     branches:
-      - master
-      #- feature/multiple-servers
+      - "release-*"
+      #- master
+  release:
+    types:
+      - published
 
 env:
   PYTHON_VERSION: 3.x
 
 jobs:
-  documentation:
-    name: Build documentation
+
+  # Documentation is deployed only on the latest release branch or on the new latest
+  # release tag. This prevents bug fixes in older releases from overwriting the latest
+  # documentation.
+  check:
+    name: Check if docs should be deployed
     runs-on: ubuntu-latest
+    outputs:
+      deploy: ${{ steps.verify.outputs.deploy }}
     steps:
+      - name: Extract release version from the branch name (or tag)
+        id: branch_version
+        uses: actions/github-script@v6
+        with:
+          result-encoding: string
+          script: |
+            const branchName = process.env.GITHUB_REF_NAME
+            const prefix = 'v'
+            const releaseVersion = branchName.substring(branchName.lastIndexOf('-') + 1, branchName.length)
+            return releaseVersion.startsWith(prefix) ? releaseVersion : prefix + releaseVersion
+
+      - name: Get latest repository version
+        id: latest_release_version
+        uses: oprypin/find-latest-tag@v1.1.0
+        with:
+          repository: ${{ github.repository }}
+          prefix: 'v'
+
+      - name: Verify if the latest version contains current branch/tag version
+        id: verify
+        env:
+          LATEST_VERSION: ${{ steps.latest_release_version.outputs.tag }}
+          BRANCH_VERSION: ${{ steps.branch_version.outputs.result }}
+        run: |
+          echo "::set-output name=deploy::${{ contains(env.LATEST_VERSION, env.BRANCH_VERSION) }}"
 
+  documentation:
+    name: Build and deploy docs
+    runs-on: ubuntu-latest
+    needs: check
+    if: needs.check.outputs.deploy == 'true'
+    steps:
       - name: Checkout repository
         uses: actions/checkout@v3
 
@@ -36,4 +76,6 @@ jobs:
             pymdown-extensions>=9.3
 
       - name: Deploy documentation
-        run: mkdocs gh-deploy --force
+        run: |
+          mkdocs gh-deploy --force
+