Feat: Additional Github Workflow Actions

.github/pr-title-checker-config.json

@@ -0,0 +1,17 @@
+{
+  "LABEL": {
+    "name": "title needs formatting",
+    "color": "EEEEEE"
+  },
+  "CHECKS": {
+    "prefixes": ["feat: ", "bugfix: ", "tidy: ", "breaking: ", "core_update: "],
+    "regexp": "^(feat|bugfix|tidy|breaking|core_update): .+",
+    "regexpFlags": "i",
+    "ignoreLabels" : ["dont-check-PRs-with-this-label", "meta"]
+  },
+  "MESSAGES": {
+    "success": "### ✅ PR Title Formatted Correctly",
+    "failure": "### 🚨 PR Title Needs Formatting\n\nThe title of this PR needs to be formatted correctly.\nPlease update the title to match the format `type: description`. For more details, see CONTRIBUTING.md.\n\n#### Examples:\n- `bugfix: fix typo in README.md AB#123`\n- `tidy: update dependencies AB#456`\n- `feat: add new feature AB#789`\n- `breaking: big change`\n",
+    "notice": ""
+  }
+}

.github/workflows/CodeQL.yml

@@ -0,0 +1,38 @@
+# This scans MaCh3 and tries to find vulnerabilities
+
+name: "CodeQL C++ Analysis"
+
+on:
+  schedule:
+    - cron: '0 0 * * 0' # Every Sunday at midnight
+
+jobs:
+  analyze:
+    name: Analyze C++ Code with CodeQL
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/dune/mach3:alma9latest
+    permissions:
+      security-events: write
+      packages: read
+      actions: read
+      contents: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: c-cpp
+          build: none  # Specify build none to skip any build steps
+
+      - name: Build Code
+        run: |
+          mkdir build
+          cd build
+          cmake ../
+          make -j4
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3

.github/workflows/Doxygen.yml

@@ -0,0 +1,56 @@
+---
+# This is a basic workflow make doxygen documentation 
+# every time develop is updated
+name: Doxygen
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the develop branch
+  push:
+    branches: [ develop ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "Doxygen"
+
+  Doxygen:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+
+      # Updates the package list to ensure you get the latest version of packages
+      - run: sudo apt-get update
+
+      # Installs texlive for LaTeX support in Doxygen documentation
+      - run: sudo apt-get install -y texlive
+
+      # Installs libjs-mathjax for rendering mathematical notation in Doxygen documentation
+      - run: sudo apt-get install -y libjs-mathjax
+
+      # Install perl for bibtex
+      - run: sudo apt-get install -y perl
+
+      # Runs a single command using the runners shell
+      - name: Doxygen Action
+        uses: mattnotmitt/[email protected]
+        with:
+          doxyfile-path: './doc/Doxyfile'
+          working-directory: .
+
+      # Deploys the generated documentation to GitHub Pages
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/html

.github/workflows/Linter.yml

@@ -0,0 +1,31 @@
+---
+# Lint our code and throw error if something is looking fishy in the changes
+name: Super Linter
+
+on:
+  pull_request:
+    branches: [develop]
+
+
+jobs:
+  super-linter:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Run Super Linter
+        uses: github/super-linter@v7
+        continue-on-error: true
+        env:
+          VALIDATE_MARKDOWN: true  # Enable Markdown linting
+          VALIDATE_DOCKERFILE: true  # Enable Dockerfile linting
+          VALIDATE_YAML: true  # Enable YAML linting
+          VALIDATE_GITHUB_ACTIONS: true  # Enable GitHub Actions workflow linting
+          VALIDATE_PYTHON: true  # Enable Python linting
+          VALIDATE_ALL_CODEBASE: true  # Lint the entire codebase
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # GitHub token for permissions
+          # DISABLE_LINTERS: "CPP"  # Disable linting for other languages

.github/workflows/PRTitleChecker.yml

@@ -0,0 +1,24 @@
+# This workflow make sure PR tittles obeys Contributing guide
+name: "PR Title Checker"
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+      - labeled
+      - unlabeled
+  workflow_dispatch:  # This allows the workflow to be triggered manually
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - uses: thehanimo/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          pass_on_octokit_error: false
+          local_configuration_path: .github/pr-title-checker-config.json

CMakeLists.txt

@@ -121,7 +121,17 @@ endif()
 ##################################  MaCh3  ######################################
 #If MaCh3 was sourced find it, otherwise use CPM
 SET(MaCh3_FOUND FALSE)
-find_package(MaCh3 1.3.5 EXACT QUIET)
+
+# KS: Here we try to find tag matching tutorial version. If we can't find one then use develop
+# This will allow to grab tutorial for tagged MaCh3 version without a need of manually changing version
+if(NOT DEFINED MaCh3_Branch)
+      SET(MaCh3_Branch "v1.3.5")
+      find_package(MaCh3 1.3.5 EXACT QUIET)
+else()
+    # If user is just trying to use their own version we can grab it
+    find_package(MaCh3 QUIET)
+endif()
+
 
 if(NOT MaCh3_FOUND)
   cmessage(STATUS "Didn't find MaCh3, attempting to use built in MaCh3")
@@ -152,7 +162,7 @@ if(NOT MaCh3_FOUND)
 
   CPMAddPackage(
       NAME MaCh3
-      GIT_TAG "v1.3.5"
+      GIT_TAG ${MaCh3_Branch}
       GITHUB_REPOSITORY mach3-software/MaCh3
   )
 else()