Skip to content

Commit a4080c4

Browse files
sebastian-petersebastian-peter
authored
Merge branch 'dev' into df/#1278-v2g-rtd
2 parents fd79814 + 513321c commit a4080c4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+472
-140
lines changed

‎.github/workflows/ci.yml

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# © 2025. TU Dortmund University,
2+
# Institute of Energy Systems, Energy Efficiency and Energy Economics,
3+
# Research group Distribution grid planning and operation
4+
#
5+
6+
name: CI
7+
8+
on:
9+
push:
10+
paths-ignore:
11+
- 'docs/**'
12+
branches:
13+
- main
14+
- dev
15+
- 'hotfix/*'
16+
- 'rel/*'
17+
- 'dependabot/*'
18+
pull_request:
19+
branches:
20+
- main
21+
- dev
22+
23+
jobs:
24+
buildAndTest:
25+
runs-on: ubuntu-latest
26+
27+
steps:
28+
- name: Checkout Source
29+
uses: actions/checkout@v4
30+
with:
31+
fetch-depth: 0
32+
33+
- name: Setup Gradle
34+
uses: gradle/actions/setup-gradle@v4
35+
36+
- name: Check Branch
37+
run: |
38+
if [ "${{ github.event_name }}" == "pull_request" ]; then
39+
BRANCH_NAME="${{ github.head_ref }}"
40+
else
41+
BRANCH_NAME="${{ github.ref_name }}"
42+
fi
43+
44+
if [[ "$BRANCH_NAME" == refs/heads/* ]]; then
45+
BRANCH_NAME="${BRANCH_NAME#refs/heads/}"
46+
fi
47+
48+
export BRANCH_NAME
49+
50+
echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV
51+
52+
./gradlew checkBranchName -PbranchName="$BRANCH_NAME" --warning-mode=none
53+
54+
bash scripts/branch_type.sh
55+
56+
- name: Version Check
57+
if: ${{ github.event_name == 'pull_request' }}
58+
env:
59+
BASE_BRANCH: ${{ github.event.pull_request.base.ref }}
60+
run: bash scripts/run-version-check.sh
61+
62+
- name: Setup Java
63+
uses: actions/setup-java@v4
64+
with:
65+
distribution: 'temurin'
66+
java-version: 17
67+
68+
- name: Build Project
69+
run: ./gradlew --refresh-dependencies clean assemble spotlessCheck
70+
71+
- name: Run Tests
72+
run: ./gradlew pmdMain pmdTest spotbugsMain spotbugsTest test jacocoTestReport jacocoTestCoverageVerification
73+
74+
- name: Build Java-Docs
75+
run: ./gradlew javadoc
76+
77+
- name: SonarQube
78+
run: |
79+
./gradlew sonar \
80+
-Dsonar.projectKey=${{ vars.SONAR_PROJECT_KEY }} \
81+
-Dsonar.host.url=${{ vars.SONAR_HOST_URL }} \
82+
-Dsonar.login=${{ secrets.SONAR_TOKEN }} \
83+
-Dsonar.qualitygate.wait=true
84+
85+
#Deployment
86+
- name: Deploy
87+
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
88+
env:
89+
ORG_GRADLE_PROJECT_signingKey: ${{ secrets.MAVENCENTRAL_SIGNINGKEY }}
90+
ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.MAVENCENTRAL_SIGNINGPASS }}
91+
ORG_GRADLE_PROJECT_user: ${{ secrets.MAVENCENTRAL_USER }}
92+
ORG_GRADLE_PROJECT_password: ${{ secrets.MAVENCENTRAL_PASS }}
93+
run: |
94+
if [ "${GITHUB_REF}" == "refs/heads/main" ]; then
95+
currentVersion=$(./gradlew -q currentVersion)
96+
else
97+
currentVersion=$(./gradlew -q devVersion)
98+
fi
99+
100+
echo "currentVersion=$currentVersion"
101+
102+
./gradlew publish -PdeployVersion=$currentVersion

‎CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased/Snapshot]
88

9+
### Added
10+
- Implemented GitHub Actions for automatic code integration. [#1237](https://github.com/ie3-institute/PowerSystemDataModel/issues/1237)
11+
12+
### Fixed
13+
14+
### Changed
15+
- Replaced `return this` with `return thisInstance` in CopyBuilders [#1250](https://github.com/ie3-institute/PowerSystemDataModel/issues/1250)
16+
917
## [6.0.0] - 2025-02-27
1018

1119
### Added

‎build.gradle

+2-1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ apply from: scriptsLocation + 'mavenCentralPublish.gradle'
4545
apply from: scriptsLocation + 'sonarqube.gradle'
4646
apply from: scriptsLocation + 'vcs.gradle'
4747
apply from: scriptsLocation + 'semVer.gradle'
48+
apply from: scriptsLocation + 'branchName.gradle' // checks naming scheme of branches
4849

4950
repositories {
5051
mavenCentral() // searches in Sonatype's repository 'Maven Central'
@@ -97,7 +98,7 @@ dependencies {
9798

9899
// Databases
99100
implementation 'org.influxdb:influxdb-java:2.24'
100-
implementation 'com.couchbase.client:java-client:3.7.8'
101+
implementation 'com.couchbase.client:java-client:3.7.9'
101102
runtimeOnly 'org.postgresql:postgresql:42.7.5' // postgresql jdbc driver required during runtime
102103

103104
implementation 'commons-io:commons-io:2.18.0' // I/O functionalities

‎gradle/scripts/branchName.gradle

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
tasks.register('checkBranchName') {
2+
doLast {
3+
if (!project.hasProperty('branchName')) {
4+
throw new GradleException("Error: Missing required property 'branchName'.")
5+
}
6+
7+
def branchName = project.property('branchName')
8+
9+
def patterns = [
10+
~/^(developer|develop|dev)$/,
11+
~/.*rel\/.*/,
12+
~/^dependabot\/.*$/,
13+
~/.*hotfix\/\pL{2}\/#\d+.*/,
14+
~/.*main/,
15+
~/^[a-z]{2}\/#[0-9]+(?:-.+)?$/
16+
]
17+
18+
def isValid = patterns.any { pattern -> branchName ==~ pattern }
19+
20+
if (!isValid) {
21+
throw new GradleException("Error: Check Branch name format (e.g., ps/#1337-FeatureName). Current branch name is $branchName.")
22+
}
23+
24+
println "Branch name is $branchName"
25+
}
26+
}

‎scripts/branch_type.sh

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#!/usr/bin/env bash
2+
set -euo pipefail
3+
4+
if [ -z "${BRANCH_NAME:-}" ]; then
5+
echo "Error: BRANCH_NAME variable is not set."
6+
exit 1
7+
fi
8+
9+
10+
pattern_dev='^(developer|develop|dev)$'
11+
pattern_release='.*rel/.*'
12+
pattern_dependabot='^dependabot/.*'
13+
pattern_hotfix='.*hotfix/.*'
14+
pattern_main='.*main'
15+
pattern_feature='^[a-z]{2}/#[0-9]+(-.+)?$'
16+
17+
BRANCH_TYPE="unknown"
18+
19+
if [[ "$BRANCH_NAME" =~ $pattern_dev ]]; then
20+
BRANCH_TYPE="dev"
21+
elif [[ "$BRANCH_NAME" =~ $pattern_release ]]; then
22+
BRANCH_TYPE="release"
23+
elif [[ "$BRANCH_NAME" =~ $pattern_dependabot ]]; then
24+
BRANCH_TYPE="dependabot"
25+
elif [[ "$BRANCH_NAME" =~ $pattern_hotfix ]]; then
26+
BRANCH_TYPE="hotfix"
27+
elif [[ "$BRANCH_NAME" =~ $pattern_main ]]; then
28+
BRANCH_TYPE="main"
29+
elif [[ "$BRANCH_NAME" =~ $pattern_feature ]]; then
30+
BRANCH_TYPE="feature"
31+
else
32+
echo "Error:'$BRANCH_NAME' does not match any pattern."
33+
exit 1
34+
fi
35+
36+
echo "========================="
37+
echo "Branch type: $BRANCH_TYPE"
38+
echo "BRANCH_TYPE=$BRANCH_TYPE" >> "$GITHUB_ENV"
39+
echo "========================="

‎scripts/get_versions.sh

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#!/bin/bash
2+
set -euo pipefail
3+
4+
cd "$(dirname "$0")/.."
5+
6+
REPO_URL=$(git config --get remote.origin.url)
7+
export REPO_URL
8+
echo "REPO_URL=$REPO_URL" >> $GITHUB_ENV
9+
10+
echo "Fetching current version of PR..."
11+
PR_VERSION=$(./gradlew -q currentVersion)
12+
echo "PR_VERSION=$PR_VERSION"
13+
echo "export PR_VERSION=$PR_VERSION" >> versions.env
14+
echo "PR_VERSION=$PR_VERSION" >> "$GITHUB_ENV"
15+
16+
get_branch_version() {
17+
local BRANCH_NAME=$1
18+
local DIR_NAME="${BRANCH_NAME}-branch"
19+
20+
git clone --depth 1 --branch "$BRANCH_NAME" "$REPO_URL" "$DIR_NAME"
21+
cd "$DIR_NAME"
22+
23+
echo "Fetching version from $BRANCH_NAME branch..."
24+
BRANCH_VERSION=$(./gradlew -q currentVersion)
25+
cd ..
26+
27+
echo "${BRANCH_NAME^^}_VERSION=$BRANCH_VERSION"
28+
echo "export ${BRANCH_NAME^^}_VERSION=$BRANCH_VERSION" >> versions.env
29+
echo "${BRANCH_NAME^^}_VERSION=$BRANCH_VERSION" >> "$GITHUB_ENV"
30+
31+
rm -rf "$DIR_NAME"
32+
}
33+
34+
35+
get_branch_version "dev"
36+
get_branch_version "main"
37+
38+
echo "Get Versions: OK!"

‎scripts/run-version-check.sh

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#!/bin/bash
2+
set -euo pipefail
3+
4+
rm -f versions.env
5+
6+
scripts/get_versions.sh
7+
8+
source versions.env
9+
10+
scripts/version_check.sh

‎scripts/version_check.sh

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
#!/bin/bash
2+
set -euo pipefail
3+
4+
cd "$(dirname "$0")/.."
5+
6+
echo "========================="
7+
echo "LOADED ENV VARIABLES:"
8+
echo "PR_VERSION: $PR_VERSION"
9+
echo "DEV_VERSION: $DEV_VERSION"
10+
echo "MAIN_VERSION: $MAIN_VERSION"
11+
echo "BASE_BRANCH: $BASE_BRANCH"
12+
echo "========================="
13+
14+
semver_gt() {
15+
IFS='.' read -r major1 minor1 patch1 <<< "$1"
16+
IFS='.' read -r major2 minor2 patch2 <<< "$2"
17+
18+
# Compare major version
19+
if [ "$major1" -gt "$major2" ]; then
20+
return 0
21+
elif [ "$major1" -lt "$major2" ]; then
22+
return 1
23+
fi
24+
25+
# Compare minor version
26+
if [ "$minor1" -gt "$minor2" ]; then
27+
return 0
28+
elif [ "$minor1" -lt "$minor2" ]; then
29+
return 1
30+
fi
31+
32+
# Compare patch version
33+
if [ "$patch1" -gt "$patch2" ]; then
34+
return 0
35+
else
36+
return 1
37+
fi
38+
}
39+
40+
# Version Checking Logic
41+
if [ "$BASE_BRANCH" = "dev" ]; then
42+
echo "PR into dev => applying dev rules"
43+
if [ "$DEV_VERSION" = "$PR_VERSION" ]; then
44+
echo "OK: PR version ($PR_VERSION) matches the current dev version ($DEV_VERSION)."
45+
exit 0
46+
else
47+
if [ "$MAIN_VERSION" = "$DEV_VERSION" ]; then
48+
if semver_gt "$PR_VERSION" "$DEV_VERSION"; then
49+
echo "OK: Increasing working version in dev from $DEV_VERSION to $PR_VERSION"
50+
exit 0
51+
else
52+
echo "FAIL: Release and working version are $MAIN_VERSION, but PR is not increasing the working version in dev"
53+
exit 1
54+
fi
55+
else
56+
echo "FAIL: PR version ($PR_VERSION) does not match the current dev version ($DEV_VERSION)."
57+
echo "Regular PRs must not update the working version. The working version should only change in controlled updates."
58+
exit 1
59+
fi
60+
fi
61+
62+
elif [ "$BASE_BRANCH" = "main" ]; then
63+
echo "PR into main => applying main rules"
64+
if semver_gt "$PR_VERSION" "$MAIN_VERSION"; then
65+
echo "OK: PR version ($PR_VERSION) is greater than the current main version ($MAIN_VERSION)."
66+
exit 0
67+
else
68+
echo "FAIL: PR version ($PR_VERSION) is NOT greater than the current main version ($MAIN_VERSION)."
69+
echo "A new release must have a higher version than the existing main version."
70+
exit 1
71+
fi
72+
73+
else
74+
echo "Skipping version check: Base branch is '$BASE_BRANCH'. No version enforcement required."
75+
exit 0
76+
fi

‎src/main/java/edu/ie3/datamodel/models/input/EmInput.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ protected EmInputCopyBuilder(EmInput entity) {
119119

120120
public EmInputCopyBuilder controlStrategy(String controlStrategy) {
121121
this.controlStrategy = controlStrategy;
122-
return this;
122+
return thisInstance();
123123
}
124124

125125
public EmInputCopyBuilder parentEm(EmInput parentEm) {

‎src/main/java/edu/ie3/datamodel/models/input/MeasurementUnitInput.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -183,27 +183,27 @@ public MeasurementUnitInput build() {
183183

184184
public MeasurementUnitInputCopyBuilder node(NodeInput node) {
185185
this.node = node;
186-
return this;
186+
return thisInstance();
187187
}
188188

189189
public MeasurementUnitInputCopyBuilder vMag(boolean vMag) {
190190
this.vMag = vMag;
191-
return this;
191+
return thisInstance();
192192
}
193193

194194
public MeasurementUnitInputCopyBuilder vAng(boolean vAng) {
195195
this.vAng = vAng;
196-
return this;
196+
return thisInstance();
197197
}
198198

199199
public MeasurementUnitInputCopyBuilder p(boolean p) {
200200
this.p = p;
201-
return this;
201+
return thisInstance();
202202
}
203203

204204
public MeasurementUnitInputCopyBuilder q(boolean q) {
205205
this.q = q;
206-
return this;
206+
return thisInstance();
207207
}
208208

209209
@Override

0 commit comments

Comments
 (0)