Merge branch '41-make-documentation-multi-versioned' into 'dev'

Resolve "Make documentation multi-versioned"

Closes #41

See merge request !16

.gitlab-ci.yml

@@ -90,18 +90,31 @@ ragdoc_view:
       - "pages/docs/ragdoc"
 
 pages:
-  image: python:3.8-buster
+  image: python:3.10.0-bullseye
   stage: publish
   needs:
     - ragdoc_view
     - test
+  variables:
+    PAGES_BRANCH: pages
+    HTTPS_REMOTE: https://${PROJECT_BOT_USER}:${PROJECT_BOT_TOKEN}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git
   before_script:
-    - pip install -U mkdocs mkdocs-macros-plugin mkdocs-git-revision-date-localized-plugin
+    - pip install -r pages/requirements.txt
+    - git config user.name $PROJECT_BOT_USER
+    - git config user.email $PROJECT_BOT_USER@git-st.inf.tu-dresden.de
+    - git fetch origin $PAGES_BRANCH || echo "Pages branch not deployed yet."
+    - git checkout $CI_COMMIT_SHA
   script:
-    - cd pages && mkdocs build
+    - cd pages
+    - export VERSION=$(python main.py)
+    - echo $VERSION
+    - mike list --json --prefix public -r $HTTPS_REMOTE -b $PAGES_BRANCH
+    - mike deploy --rebase --prefix public -r $HTTPS_REMOTE -p -b $PAGES_BRANCH --update-aliases $VERSION
+    - cd ..
+    - git checkout $PAGES_BRANCH -- public/
+  artifacts:
+    paths:
+      - public/
   only:
     - dev
     - master
-  artifacts:
-    paths:
-    - public

pages/main.py

+import os
+
 ragconnectVersionFileName = '../ragconnect.base/src/main/resources/ragConnectVersion.properties'
 
 
 def get_version():
+    if os.environ.get('CI_COMMIT_BRANCH', 'unknown') == 'dev':
+        return 'dev'
     with open(ragconnectVersionFileName) as ragconnectVersionFile:
         versionFileContent = ragconnectVersionFile.read()
     return versionFileContent[versionFileContent.rindex('version=') + 8:].strip()

pages/requirements.txt

+mkdocs==1.2.2
+mkdocs-git-revision-date-localized-plugin==0.10.3
+mkdocs-macros-plugin==0.6.3
+mike==1.1.2