Merge branch 'marenz.pin_ci_version' into gpu_flops

.github/workflows/clang-format.yml

@@ -5,13 +5,12 @@ on: [push, pull_request]
 
 jobs:
   clang-format:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - name: Install clang-tidy
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y clang-tidy
+      - uses: actions/checkout@v4
+        with:
+          submodules: 'true'
+
       - name: Analyze
         run: |
           clang-format --dry-run --Werror -style=file $(find ./src/ -name '*.cpp' -print)

.github/workflows/clang-tidy.yml

@@ -7,7 +7,7 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
     - uses: actions/checkout@v4

.github/workflows/cmake.yml

@@ -316,7 +316,7 @@ jobs:
     - name: Test FIRESTARTER (default)
       run: ./build/src/FIRESTARTER -t 1
     - uses: actions/upload-artifact@v4
-      if: matrix.compiler == 'clang-18' && ( github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') || github.event_name == 'pull_request' )
+      if: matrix.os == 'ubuntu-20.04' && matrix.compiler == 'default' && ( github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') || github.event_name == 'pull_request' )
       with:
         name: FIRESTARTER-linux
         retention-days: 1

.github/workflows/ctest.yml

@@ -7,7 +7,7 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
     - uses: actions/checkout@v4

DeveloperDocumenation.md

@@ -0,0 +1,25 @@
+# Developer Documentation
+
+This document contains knowledge required to work on the FIRESTARTER project.
+
+## Coding Guidelines
+
+Code style follows the LLVM project.
+It is enforced by an automatic CI check.
+The currently used version for `clang-format` and `clang-tidy` is `1.14` (the default for Ubuntu 22.04).
+
+When using VSCode as your editor it is recomended that you install the [Clang-Format](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format) and [clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd) extension.
+
+## Building
+
+The project can be build using CMake.
+See `Building FIRESTARTER` Section in the Readme for more details.
+
+## Running tests
+
+Tests will be build when passing the variable `-DFIRESTARTER_BUILD_TESTS=ON` to CMake.
+
+To run the standard set of tests run `ctest` in the build directory.
+
+To run `clang-tidy` with your changes execute `./tooling/clang-tidy.py clang-tidy-report --build-root <YOUR_BUILD_DIRECTORY>`.
+This will create a file called `clang-tidy-report.txt` in the build root containing the failed clang-tidy checks.