FAIRSPC-87: added workflow to Build and deploy docs to Github Pages a…

…nd fixed table in doc

.github/workflows/build_and_deploy_docs.yaml

@@ -25,15 +25,19 @@ jobs:
         with:
           ruby-version: '2.7'
 
-      - name: Install Asciidoctor
+      - name: Install Asciidoctor to build docs
         run: |
           gem install asciidoctor
           gem install asciidoctor-pdf
           gem install rouge
 
       - name: Run Build Docs script
-        run: ./docs/build.sh
+        run: ./docs/scripts/build.sh
 
       - name: Run Deploy Docs script
-        run: ./docs/deploy.sh
+        env:
+          CI_SERVICE_ACCOUNT_USER: ${{ secrets.CI_SERVICE_ACCOUNT_USER }}
+          CI_SERVICE_ACCOUNT_PASSWORD: ${{ secrets.FNS_PAT }}
+          DOCUMENTATION_REPO: ${{ vars.DOCUMENTATION_REPO }}
+        run: ./docs/scripts/deploy.sh
 

docs/build.sh → docs/scripts/build.sh

@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
+# the script builds the documentation and saves it to the build directory to be deployed by the deploy.sh script
+set -e
 
 PROJECT_FILES=(
   "projects/saturn/src/main/resources/log4j2.properties"
@@ -9,8 +11,12 @@ PROJECT_FILES=(
 )
 
 
+# Get the directory where the script is located
 here=$(dirname "${0}")
-pushd "${here}"
+# Move one level up from the script's directory
+parent_dir=$(cd "${here}/.." && pwd)
+
+pushd "${parent_dir}"
 version=$(cat ../VERSION)
 mkdir -p build/docs
 cp ../README.adoc build/

docs/scripts/deploy.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+# the script pulls the documentation repository, copies the built documentation to the repository, commits and pushes the changes
+# the documentation repository is configured to deploy the documentation to the GitHub Pages on push to the main branch
+set -e
+
+# Get the directory where the script is located
+here=$(dirname "${0}")
+# Move two levels up from the script's directory
+parent_dir=$(cd "${here}/../../" && pwd)
+
+export DOCS_REPO="https://${CI_SERVICE_ACCOUNT_USER}:${CI_SERVICE_ACCOUNT_PASSWORD}@github.com/thehyve/${DOCUMENTATION_REPO}"
+echo "Cloning documentation repository ${DOCS_REPO} ..."
+git clone --branch main "${DOCS_REPO}" fairspace-docs
+git config  --global user.email "[email protected]"
+git config  --global user.name "${CI_SERVICE_ACCOUNT_USER}"
+export DOCS_DIR=$(pwd)/fairspace-docs
+
+cp -r ./fairspace/docs/build/* "${DOCS_DIR}/"
+
+pushd "${DOCS_DIR}"
+if [ ! "$(git status -s)" == "" ]; then
+  echo "Committing changes to ${DOCUMENTATION_REPO} ..."
+  git add .
+  git commit -a -m "Update documentation"
+  git push "${DOCS_REPO}" main
+else
+  echo "Documentation unchanged."
+fi
+popd