Update documentation, readme and update workflows (#37)

Author: btschwertfeger

.dockerignore

@@ -0,0 +1,8 @@
+*
+!cmake
+!src
+!include
+!Makefile
+!tests
+!validation
+!CMakeLists.txt

.github/workflows/_build.yaml

@@ -17,7 +17,7 @@ jobs:
       image: alpine:3.17
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install dependencies
         run: |

.github/workflows/_build_doc.yaml

@@ -22,17 +22,17 @@ jobs:
     runs-on: ${{ inputs.os }}
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python ${{ inputs.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ inputs.python-version }}
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r docs/requirements.txt
+          python -m pip install -r doc/requirements.txt
 
       - name: Build the documentation
         run: make doc

.github/workflows/_pre_commit.yaml

@@ -15,5 +15,5 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - uses: pre-commit/[email protected]

.github/workflows/_test.yaml

@@ -17,7 +17,7 @@ jobs:
       image: alpine:3.17
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install dependencies
         run: |

.github/workflows/cicd.yaml

@@ -12,6 +12,10 @@ on:
   push:
     branches:
       - "**"
+  schedule:
+    - cron: "20 16 * * 0"
+  release:
+    types: [created]
 
 concurrency:
   group: CICD-${{ github.ref }}
@@ -46,11 +50,41 @@ jobs:
   ##  Create and upload a docker image
   ##
   Docker:
-    if: success() && github.ref == 'refs/heads/dev'
+    if: success() && github.event_name == 'push'
     needs: [Build, Test]
     uses: ./.github/workflows/_build_docker.yaml
     with:
       TAG: ${{ github.ref_name }}
     secrets:
       DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
       DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+
+  ##  Create and upload the tagged docker image
+  ##
+  Docker-tag:
+    if: |
+      success() &&
+      github.actor == 'btschwertfeger' &&
+      github.event_name == 'release'
+    needs: [Build, Test]
+    uses: ./.github/workflows/_build_docker.yaml
+    with:
+      TAG: ${{ github.ref_name }}
+    secrets:
+      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+      DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+
+  ##  Create and upload the latest docker image
+  ##
+  Docker-latest:
+    if: |
+      success() &&
+      github.actor == 'btschwertfeger' &&
+      github.event_name == 'release'
+    needs: [Build, Test]
+    uses: ./.github/workflows/_build_docker.yaml
+    with:
+      TAG: latest
+    secrets:
+      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+      DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}

.github/workflows/release.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer

.github/workflows/release.yml

@@ -13,7 +13,7 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+  configuration: doc/conf.py
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 # formats:
@@ -22,4 +22,4 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: doc/requirements.txt