Implementation of GHA Pipeline for PSDM

.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+# © 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 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
+
+          echo "branch_name=$branch_name" >> $GITHUB_ENV
+
+          ./gradlew checkBranchName -PbranchName="$branch_name"
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 17
+
+      - name: Build Project
+        run: ./gradlew --refresh-dependencies clean assemble spotlessCheck spotbugsMain
+
+      - name: Run Tests
+        run: ./gradlew spotbugsTest 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

CHANGELOG.md

@@ -16,13 +16,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Extend ValidationUtils for validating ThermalGrids [#1216](https://github.com/ie3-institute/PowerSystemDataModel/issues/1216) 
 - Enhance `TimeSeriesSource` with method to retrieve the previous value before a given key [#1182](https://github.com/ie3-institute/PowerSystemDataModel/issues/1182)
 - Added `BdewLoadProfileTimeSeries` [#1230](https://github.com/ie3-institute/PowerSystemDataModel/issues/1230)
+- Implemented GitHub Actions Pipeline [#1237](https://github.com/ie3-institute/PowerSystemDataModel/issues/1237)
 - Added `RandomLoadProfileTimeSeries` [#1232](https://github.com/ie3-institute/PowerSystemDataModel/issues/1232)
 - Attribute `pThermalRated` for `ThermalStorage`s [#679](https://github.com/ie3-institute/PowerSystemDataModel/issues/679) 
 - Attributes `housingType` and `numberInhabitants` for `ThermalHouse`s [#1253](https://github.com/ie3-institute/PowerSystemDataModel/issues/1253)
 - Added domestic hot water storage model [#1257](https://github.com/ie3-institute/PowerSystemDataModel/issues/1257)
 - Validation for BDEW load profile values [#1243](https://github.com/ie3-institute/PowerSystemDataModel/issues/1243)
 - Added load profiles sources [#1106](https://github.com/ie3-institute/PowerSystemDataModel/issues/1106)
 
+
 ### Fixed
 - Removing opened `SwitchInput` during connectivity check [#1221](https://github.com/ie3-institute/PowerSystemDataModel/issues/1221)
 - Fixed example in ReadTheDocs [#1244](https://github.com/ie3-institute/PowerSystemDataModel/issues/1244)

build.gradle

@@ -45,6 +45,7 @@ apply from: scriptsLocation + 'mavenCentralPublish.gradle'
 apply from: scriptsLocation + 'sonarqube.gradle'
 apply from: scriptsLocation + 'vcs.gradle'
 apply from: scriptsLocation + 'semVer.gradle'
+apply from: scriptsLocation + 'branchName.gradle' // checks naming scheme of branches
 
 repositories {
   mavenCentral() // searches in Sonatype's repository 'Maven Central'

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"
   }
 }