Implementing GitHub Actions Pipeline #982
+100
−2
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| # © 2024. TU Dortmund University, | ||
| # Institute of Energy Systems, Energy Efficiency and Energy Economics, | ||
| # Research group Distribution grid planning and operation | ||
| # | ||
|
|
||
| name: CI | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - dev | ||
| - 'feature/*' | ||
| - 'hotfix/*' | ||
| - 'release/*' | ||
|
Comment on lines
+13
to
+15
There was a problem hiding this comment. You probably know this, but these have to be adapted to the branch naming scheme that we use |
||
| pull_request: | ||
| branches: | ||
| - main | ||
| - dev | ||
|
Comment on lines
+18
to
+19
There was a problem hiding this comment. Do we still need the pull_request specification, if CI is running on branches already? |
||
|
|
||
| jobs: | ||
|
|
||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout Source | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ github.event.pull_request.head.ref || github.ref }} | ||
| repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }} | ||
|
|
||
| - name: Determine Project Version | ||
| id: version | ||
| run: | | ||
| branch_name=$(echo ${{ github.ref_name }}) | ||
| project_version=$(./gradlew -q $([ "$branch_name" = "dev" ] && echo "devVersion" || echo "currentVersion")) | ||
| echo "project_version=${project_version}" >> $GITHUB_ENV | ||
|
|
||
| - name: Setup Java | ||
| uses: actions/setup-java@v4 | ||
| with: | ||
| distribution: 'temurin' | ||
| java-version: 17 | ||
|
|
||
| - name: Setup Gradle 8.10 | ||
| uses: gradle/actions/setup-gradle@v4 | ||
| with: | ||
| gradle-version: "8.10" | ||
|
Comment on lines
+48
to
+49
There was a problem hiding this comment. Seems like you can leave out the specification of the version if the project already configures gradle (which it does). |
||
|
|
||
| - name: Build Project | ||
| run: | | ||
| ./gradlew clean assemble | ||
|
|
||
| - name: Run Tests | ||
| run: | | ||
| ./gradlew --refresh-dependencies spotlessCheck pmdMain pmdTest | ||
|
There was a problem hiding this comment.
|
||
|
|
||
| - name: Build Scala-Docs | ||
| run: | | ||
| ./gradlew scaladoc | ||
|
|
||
| - name: SonarQube Analysis | ||
| uses: sonarsource/sonarqube-scan-action@master | ||
| with: | ||
| projectBaseDir: '.' | ||
| args: > | ||
| -Dsonar.projectKey=${{ vars.SONAR_PROJECT_KEY }} | ||
| -Dsonar.java.binaries=build/classes/scala/main | ||
| -Dsonar.verbose=true | ||
| -Dsonar.sourceEncoding=UTF-8 | ||
| -Dsonar.sources=src/main/resources,src/main/scala | ||
| -Dsonar.tests=src/test/resources,src/test/scala,src/test/groovy | ||
| -Dsonar.junit.reportPaths=build/test-results/test | ||
| -Dsonar.scala.scapegoat.reportPaths=build/reports/scapegoat/src/scapegoat-scalastyle.xml,build/reports/scapegoat/testsrc/scapegoat-scalastyle.xml | ||
| -Dsonar.scala.coverage.reportPaths=build/reports/scoverageTest/scoverage.xml | ||
| -Dsonar.groovy.binaries=build/classes/groovy | ||
| -Dsonar.exclusions=src/main/scala/edu/ie3/simona/config/SimonaConfig.scala | ||
| env: | ||
| SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} | ||
| SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }} | ||
|
|
||
| - name: SonarQube Quality Gate | ||
| id: sonarqube-quality-gate-check | ||
| uses: sonarsource/sonarqube-quality-gate-action@master | ||
| # Force to fail step after specific time. | ||
| timeout-minutes: 60 | ||
|
There was a problem hiding this comment. This could probably be reduced (but isn't that important) |
||
| env: | ||
| SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} | ||
| SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }} | ||
|
|
||
| - name: Deploy | ||
| if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev' | ||
| run: | | ||
| ./gradlew --refresh-dependencies test publish\ | ||
| -Puser=${{ secrets.MAVENCENTRAL_USER }} \ | ||
| -Ppassword=${{ secrets.MAVENCENTRAL_PASS }} \ | ||
| -Psigning.keyId=${{ secrets.MAVENCENTRAL_SIGNINGKEYID }} \ | ||
| -Psigning.password=${{ secrets.MAVENCENTRAL_SIGNINGPASS }} \ | ||
| -Psigning.secretKeyRingFile=${{ secrets.MAVENCENTRAL_SIGNINGKEY }} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
paths-ignorefor docs could also be useful? readthedocs has its separate CI