Merge branch 'dev' into ms/#251-upgrade-to-scala3

# Conflicts:
#	CHANGELOG.md

Author: staudtMarius

.github/workflows/ci.yml

@@ -0,0 +1,102 @@
+# © 2025. TU Dortmund University,
+# Institute of Energy Systems, Energy Efficiency and Energy Economics,
+# Research group Distribution grid planning and operation
+#
+
+name: CI
+
+on:
+  push:
+    paths-ignore:
+      - 'docs/**'
+    branches:
+      - main
+      - dev
+      - 'hotfix/*'
+      - 'rel/*'
+      - 'dependabot/*'
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  buildAndTest:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Source
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 17
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Check Branch
+        run: |
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            BRANCH_NAME="${{ github.head_ref }}"
+          else
+            BRANCH_NAME="${{ github.ref_name }}"
+          fi
+
+          if [[ "$BRANCH_NAME" == refs/heads/* ]]; then
+            BRANCH_NAME="${BRANCH_NAME#refs/heads/}"
+          fi
+          
+          export BRANCH_NAME
+          
+          echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV
+          
+          ./gradlew checkBranchName -PbranchName="$BRANCH_NAME" --warning-mode=none
+          
+          bash scripts/branch_type.sh
+
+      - name: Version Check
+        if: ${{ github.event_name == 'pull_request' }}
+        env:
+          BASE_BRANCH: ${{ github.event.pull_request.base.ref }}
+        run: bash scripts/run-version-check.sh
+
+      - name: Build Project
+        run: ./gradlew --refresh-dependencies clean assemble spotlessCheck
+
+      - name: Run Tests
+        run: ./gradlew pmdMain pmdTest test jacocoTestReport jacocoTestCoverageVerification
+
+      - name: Build Java-Docs
+        run: ./gradlew javadoc
+
+      - name: SonarQube
+        run: |
+          ./gradlew sonar \
+          -Dsonar.projectKey=${{ vars.SONAR_PROJECT_KEY }} \
+          -Dsonar.host.url=${{ vars.SONAR_HOST_URL }} \
+          -Dsonar.login=${{ secrets.SONAR_TOKEN }} \
+          -Dsonar.qualitygate.wait=true
+
+      #Deployment
+      - name: Deploy
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
+        env:
+          ORG_GRADLE_PROJECT_signingKey: ${{ secrets.MAVENCENTRAL_SIGNINGKEY }}
+          ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.MAVENCENTRAL_SIGNINGPASS }}
+          ORG_GRADLE_PROJECT_user: ${{ secrets.MAVENCENTRAL_USER }}
+          ORG_GRADLE_PROJECT_password: ${{ secrets.MAVENCENTRAL_PASS }}
+        run: |
+          if [ "${GITHUB_REF}" == "refs/heads/main" ]; then
+            currentVersion=$(./gradlew -q currentVersion)
+          else
+            currentVersion=$(./gradlew -q devVersion)
+          fi
+          
+          echo "currentVersion=$currentVersion"
+
+          ./gradlew publish -PdeployVersion=$currentVersion

.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,24 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]' && github.repository == 'ie3-institute/simonaAPI'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@d7267f607e9d3fb96fc2fbe83e0af444713e90b7
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Enable auto-merge for Dependabot PRs
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch'
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -5,12 +5,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased/Snapshot]
+### Added
+- Implementing auto-merge for dependabot PRs [#273](https://github.com/ie3-institute/simonaAPI/issues/273)
+- Implemented GitHub Actions pipeline [#247](https://github.com/ie3-institute/simonaAPI/issues/247)
+
+### Changed
+- Converting pekko classic to typed [#232](https://github.com/ie3-institute/simonaAPI/issues/232)
+
+## [0.7.0] - 2025-03-11
 
 ### Added
 - Added Bao and Staudt to the list of reviewers [#216](https://github.com/ie3-institute/simonaAPI/issues/216)
 - Documentation for this API [#230](https://github.com/ie3-institute/simonaAPI/issues/230)
 
-### Changed
+#### Changed
+- Updated PSDM to 6.0.0
 - Upgraded to `scala3` [#251](https://github.com/ie3-institute/simonaAPI/issues/251)
 
 ## [0.6.0] - 2024-12-02
@@ -54,7 +63,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Renamed messages to ease understanding [#62](https://github.com/ie3-institute/simonaAPI/issues/62)
 - Separating departures and arrivals in message protocol, properly handling exceptions [#77](https://github.com/ie3-institute/simonaAPI/issues/77)
 
-[Unreleased/Snapshot]: https://github.com/ie3-institute/simonaapi/compare/0.6.0...HEAD
+[Unreleased/Snapshot]: https://github.com/ie3-institute/simonaapi/compare/0.7.0...HEAD
+[0.7.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/0.6.0...0.7.0
 [0.6.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/0.5.0...0.6.0
 [0.5.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/0.4.0...0.5.0
 [0.4.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/0.3.0...0.4.0

build.gradle

@@ -1,10 +1,10 @@
 plugins {
   id 'groovy' // groovy support
   id 'java' // java support
-  id 'com.diffplug.spotless' version '7.0.2'//code format
+  id 'com.diffplug.spotless' version '7.0.3'//code format
   id 'pmd' // code check, working on source code
-  id 'com.github.spotbugs' version '6.1.5' // code check, working on byte code
-  id "org.sonarqube" version "6.0.1.5171" // sonarqube
+  id 'com.github.spotbugs' version '6.1.7' // code check, working on byte code
+  id "org.sonarqube" version "6.1.0.5360" // sonarqube
   id 'signing'
   id 'maven-publish' // publish to a maven repo (local or mvn central, has to be defined)
   id 'jacoco' // java code coverage plugin
@@ -40,6 +40,7 @@ apply from: scriptsLocation + 'mavenCentralPublish.gradle'
 apply from: scriptsLocation + 'jacoco.gradle'
 apply from: scriptsLocation + 'documentation.gradle'
 apply from: scriptsLocation + 'test.gradle'
+apply from: scriptsLocation + 'branchName.gradle'
 
 repositories {
   mavenCentral()
@@ -61,7 +62,7 @@ dependencies{
   }
 
   //PSDM
-  implementation('com.github.ie3-institute:PowerSystemDataModel:5.1.0') {
+  implementation('com.github.ie3-institute:PowerSystemDataModel:6.0.0') {
     exclude group: 'org.apache.logging.log4j'
     exclude group: 'org.slf4j'
     /* Exclude our own nested dependencies */
@@ -75,8 +76,9 @@ dependencies{
   implementation 'org.apache.logging.log4j:log4j-slf4j-impl' // log4j -> slf4j
 
   // pekko
-  implementation "org.apache.pekko:pekko-actor_${scalaVersion}:${pekkoVersion}"
-  testImplementation "org.apache.pekko:pekko-testkit_${scalaVersion}:${pekkoVersion}" // pekko testkit
+  implementation "org.apache.pekko:pekko-actor-typed_${scalaVersion}:${pekkoVersion}"
+
+  testImplementation "org.apache.pekko:pekko-actor-testkit-typed_${scalaVersion}:${pekkoVersion}" // pekko typed testkit
 
   // TESTING
   testImplementation 'org.spockframework:spock-core:2.3-groovy-4.0'

docs/readthedocs/requirements.txt

@@ -1,6 +1,6 @@
 commonmark==0.9.1
 recommonmark==0.7.1
-Sphinx==8.1.3
+Sphinx==8.2.3
 sphinx-rtd-theme==3.0.2
-myst-parser==4.0.0
+myst-parser==4.0.1
 markdown-it-py==3.0.0

gradle/scripts/branchName.gradle

@@ -0,0 +1,26 @@
+tasks.register('checkBranchName') {
+  doLast {
+    if (!project.hasProperty('branchName')) {
+      throw new GradleException("Error: Missing required property 'branchName'.")
+    }
+
+    def branchName = project.property('branchName')
+
+    def patterns = [
+      ~/^(developer|develop|dev)$/,
+      ~/.*rel\/.*/,
+      ~/^dependabot\/.*$/,
+      ~/.*hotfix\/\pL{2}\/#\d+.*/,
+      ~/.*main/,
+      ~/^[a-z]{2}\/#[0-9]+(?:-.+)?$/
+    ]
+
+    def isValid = patterns.any { pattern -> branchName ==~ pattern }
+
+    if (!isValid) {
+      throw new GradleException("Error: Check Branch name format (e.g., ps/#1337-FeatureName). Current branch name is $branchName.")
+    }
+
+    println "Branch name is $branchName"
+  }
+}

gradle/scripts/semVer.gradle

@@ -1,13 +1,13 @@
 // tasks for semantic versioning using semver-gradle https://github.com/ethauvin/semver-gradle
 
-task currentVersion {
-  doFirst{
+tasks.register('currentVersion') {
+  doFirst {
     println semver.semver
   }
 }
 
-task devVersion {
-  doFirst{
+tasks.register('devVersion') {
+  doFirst {
     println "${semver.major}.${semver.minor}-SNAPSHOT"
   }
 }

gradle/scripts/spotless.gradle

@@ -20,17 +20,15 @@ spotless {
     licenseHeader "#!groovy\n\n" + ie3LicHead, "////////////////////////////////"
     // the Groovy Eclipse formatter extends the Java Eclipse formatter,
     // so it formats Java files by default (unless `excludeJava` is used).
-    // FIXME rolled back greclipse version https://github.com/diffplug/spotless/issues/1860
-    greclipse('4.27')
-    indentWithSpaces 2
+    greclipse()
+    leadingTabsToSpaces 2
   }
 
   groovyGradle {
     // same as groovy, but for .gradle (defaults to '*.gradle')
     target '*.gradle', 'gradle/scripts/*.gradle'
-    // FIXME rolled back greclipse version https://github.com/diffplug/spotless/issues/1860
-    greclipse('4.27')
-    indentWithSpaces 2
+    greclipse()
+    leadingTabsToSpaces 2
   }
 
   //sets a license header, removes unused imports and formats conforming to the scala fmt formatter
@@ -43,15 +41,15 @@ spotless {
   format 'misc', {
     target '**/.gitignore', 'configs/**'
     trimTrailingWhitespace()
-    indentWithTabs()
+    leadingSpacesToTabs()
     endWithNewline()
   }
 
   /* Formats markdown files, just like the other misc files, but without trimming trailing white spaces (nested
    * enumerations) */
   format 'md', {
     target '**/*.md'
-    indentWithSpaces 2
+    leadingTabsToSpaces 2
     endWithNewline()
   }
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

scripts/branch_type.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+if [ -z "${BRANCH_NAME:-}" ]; then
+  echo "Error: BRANCH_NAME variable is not set."
+  exit 1
+fi
+
+
+pattern_dev='^(developer|develop|dev)$'
+pattern_release='.*rel/.*'
+pattern_dependabot='^dependabot/.*'
+pattern_hotfix='.*hotfix/.*'
+pattern_main='.*main'
+pattern_feature='^[a-z]{2}/#[0-9]+(-.+)?$'
+
+BRANCH_TYPE="unknown"
+
+if [[ "$BRANCH_NAME" =~ $pattern_dev ]]; then
+  BRANCH_TYPE="dev"
+elif [[ "$BRANCH_NAME" =~ $pattern_release ]]; then
+  BRANCH_TYPE="release"
+elif [[ "$BRANCH_NAME" =~ $pattern_dependabot ]]; then
+  BRANCH_TYPE="dependabot"
+elif [[ "$BRANCH_NAME" =~ $pattern_hotfix ]]; then
+  BRANCH_TYPE="hotfix"
+elif [[ "$BRANCH_NAME" =~ $pattern_main ]]; then
+  BRANCH_TYPE="main"
+elif [[ "$BRANCH_NAME" =~ $pattern_feature ]]; then
+  BRANCH_TYPE="feature"
+else
+  echo "Error:'$BRANCH_NAME' does not match any pattern."
+  exit 1
+fi
+
+echo "========================="
+echo "Branch type: $BRANCH_TYPE"
+echo "BRANCH_TYPE=$BRANCH_TYPE" >> "$GITHUB_ENV"
+echo "========================="