Merge branch 'main' into whitesource/configure

.github/issue-labeler.yml

@@ -0,0 +1,6 @@
+docker:
+  - docker
+
+documentation:
+  - documentation
+  - docs

.github/pullrequest-labeler.yml

@@ -0,0 +1,11 @@
+github:
+  - changed-files:
+    - any-glob-to-any-file: .github/**/*
+
+documentation:
+  - changed-files:
+      - any-glob-to-any-file: docs/**/*
+
+docker:
+  - changed-files:
+      - any-glob-to-any-file: docker/**/*

.github/workflows/issue-labeler.yml

@@ -0,0 +1,17 @@
+name: "Issue Labeler"
+on:
+  issues:
+    types: [opened, edited]
+
+permissions:
+  issues: write
+  contents: read
+
+jobs:
+  triage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: MaximilianAnzinger/issue-labeler@1.0.1
+        with:
+          configuration-path: .github/issue-labeler.yml
+          repo-token: ${{ github.token }}

.github/workflows/pullrequest-labeler.yml

@@ -0,0 +1,12 @@
+name: Pull Request Labeler
+on: [pull_request_target]
+
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/labeler@v5
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          configuration-path: .github/pullrequest-labeler.yml
+          sync-labels: true

.github/workflows/pullrequest-opened.yml

@@ -0,0 +1,13 @@
+name: Pull Request Opened
+on:
+  pull_request_target:
+    types: [opened]
+
+jobs:
+  assign:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Assign Pull Request to its Author
+        uses: technote-space/assign-author@v1
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pullrequest-stale.yml

@@ -0,0 +1,26 @@
+name: Stale
+on:
+  schedule:
+    - cron: "0 12 * * *"
+
+jobs:
+  stale:
+    if: github.repository_owner == 'ls1intum'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check for stale PRs
+        uses: actions/stale@v9
+        with:
+          days-before-stale: 7
+          days-before-close: 14
+          # Disable issue checking, only PR
+          days-before-issue-stale: -1
+          remove-stale-when-updated: true
+          stale-pr-label: "stale"
+          exempt-pr-labels: "no-stale"
+          labels-to-remove-when-stale: "ready for review, ready to merge"
+          stale-pr-message: >
+            There hasn't been any activity on this pull request recently. 
+            Therefore, this pull request has been automatically marked as stale
+            and will be closed if no further activity occurs within **seven** days.
+            Thank you for your contributions.

.github/workflows/validate-pr-title.yml

@@ -0,0 +1,15 @@
+
+name: Validate PR Title
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review, edited]
+
+jobs:
+  validate-pr-title:
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    steps:
+      - uses: Slashgear/action-check-pr-title@v4.3.0
+        with:
+          regexp: '^`(Development|General)`:\s[A-Z].*$'

.gitignore

@@ -0,0 +1,85 @@
+######################
+# Eclipse
+######################
+*.pydevproject
+.project
+.metadata
+tmp/
+tmp/**/*
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath
+.factorypath
+/src/main/resources/rebel.xml
+
+# External tool builders
+.externalToolBuilders/**
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# PDT-specific
+.buildpath
+
+######################
+# Intellij
+######################
+.idea/*
+!.idea/runConfigurations/
+!.idea/icon.svg
+*.iml
+*.iws
+*.ipr
+*.ids
+*.orig
+classes/
+.IntelliJIdea*/
+.local/share/JetBrains/
+.java/
+out/
+
+######################
+# Visual Studio Code
+######################
+.vscode/
+
+######################
+# Windows
+######################
+# Windows image file caches
+Thumbs.db
+
+# Folder config file
+Desktop.ini
+
+######################
+# Mac OSX
+######################
+.DS_Store
+.svn
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+######################
+# Directories
+######################
+/bin/
+/deploy/
+
+######################
+# Logs
+######################
+*.log*

docs/.gitignore

@@ -0,0 +1,6 @@
+_build/
+.venv/
+.idea/
+__pycache__/
+.env
+venv

docs/.readthedocs.yaml

@@ -0,0 +1,12 @@
+---
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+sphinx:
+  fail_on_warning: true
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/Dockerfile

@@ -0,0 +1,15 @@
+FROM sphinxdoc/sphinx
+
+WORKDIR /docs
+# create non-root user to be able to edit the generated files without root access later
+RUN groupadd -g 1000 sphinx-user \
+    && useradd -ms /bin/bash -u 1000 -g 1000 sphinx-user \
+    && chown 1000:1000 /docs
+ADD requirements.txt /docs
+RUN pip3 install -r requirements.txt
+
+USER sphinx-user
+EXPOSE 8000
+# use the autobuild as default command
+ENV SPHINXOPTS="--port 8000 --host 0.0.0.0"
+CMD exec make livehtml

docs/Makefile

@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+# -W: treat warnings as errors
+SPHINXOPTS    ?= -W
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)