feat: OpenAPI specification

Refs: #35
SchweizerischeBundesbahnen · Sep 3, 2024 · 0ed4e28 · 0ed4e28
1 parent 0ea71cc
commit 0ed4e28
Showing 1 changed file with 55 additions and 26 deletions.
diff --git a/.github/workflows/maven-build.yml b/.github/workflows/maven-build.yml
@@ -15,23 +15,42 @@ jobs:
       GITHUB_TOKEN: ${{ github.token }}
       MARKDOWN2HTML_MAVEN_PLUGIN_FAIL_ON_ERROR: true
     steps:
-      - name: Checkout
+      # Checkout the repository
+      - name: 📄 Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4
-      - name: Set up JDK and Maven
+        with:
+          fetch-depth: 0
+
+      # Set up JDK and Maven
+      - name: 🧱 Set up JDK and Maven
         uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018  # v4
         with:
           distribution: adopt
           java-version: 17
           gpg-private-key: ${{ secrets.COM_SONATYPE_CENTRAL_POLARION_OPENSOURCE_GPG_PRIVATE_KEY }}
-      - name: Prepare Cache
+
+      # Get the project version
+      - name: 📝 Store project version
+        id: project_version
+        run: echo "project_version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_OUTPUT
+
+      # Generate cache key
+      - name: 📝 Store cache key
+        id: cache_key
+        run: echo "cache_key=${{ runner.os }}-mvn-${{ hashFiles('**/pom.xml') }}-${{ github.sha }}" >> $GITHUB_OUTPUT
+
+      # Prepare cache using cache key
+      - name: 💾 Prepare Cache
         id: prepare-cache
         uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9  # v4
         with:
           path: |
             /home/runner/.m2
             /home/runner/work
-          key: ${{ runner.os }}-mvn-${{ hashFiles('**/pom.xml') }}
-      - name: Generate settings.xml
+          key: ${{ steps.cache_key.outputs.cache_key }}
+
+      # Generate settings.xml for Maven
+      - name: 🔘 Generate settings.xml
         uses: whelk-io/maven-settings-xml-action@9dc09b23833fa9aa7f27b63db287951856f3433d  # v22
         with:
           repositories: >
@@ -78,21 +97,19 @@ jobs:
                 }
               }
             ]
-      - name: Print settings.xml
+
+      # Print settings.xml
+      - name: 🔘 Print settings.xml
         run: cat /home/runner/.m2/settings.xml
-      - name: Build with Maven
+
+      # Build with Maven
+      - name: 📦 Build with Maven
         run: mvn --batch-mode clean package
-      - name: Store project version
-        id: project_version
-        run: echo "project_version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_OUTPUT
-      - name: Store cache key
-        id: cache_key
-        run: echo "cache_key=${{ runner.os }}-mvn-${{ hashFiles('**/pom.xml') }}" >> $GITHUB_OUTPUT
     outputs:
       project_version: ${{ steps.project_version.outputs.project_version }}
       cache_key: ${{ steps.cache_key.outputs.cache_key }}
 
-  # deploy to Maven Central
+  # Deploy release to Maven Central
   deploy-maven-central:
     needs: build
     runs-on: ubuntu-latest
@@ -104,21 +121,26 @@ jobs:
       COM_SONATYPE_CENTRAL_POLARION_OPENSOURCE_TOKEN: ${{ secrets.COM_SONATYPE_CENTRAL_POLARION_OPENSOURCE_TOKEN }}
       COM_SONATYPE_CENTRAL_POLARION_OPENSOURCE_GPG_PASSPHRASE: ${{ secrets.COM_SONATYPE_CENTRAL_POLARION_OPENSOURCE_GPG_PASSPHRASE }}
     steps:
-      - name: Set up JDK and Maven
-        uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018 # v4
+      # Set up JDK and Maven
+      - name: 🧱 Set up JDK and Maven
+        uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018  # v4
         with:
           distribution: adopt
           java-version: 17
           gpg-private-key: ${{ secrets.COM_SONATYPE_CENTRAL_POLARION_OPENSOURCE_GPG_PRIVATE_KEY }}
-      - name: Restore Cache
+
+      # Restore cache using cache key
+      - name: 💾 Restore Cache
         id: restore-cache
         uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9  # v4
         with:
           path: |
             /home/runner/.m2
             /home/runner/work
           key: ${{ needs.build.outputs.cache_key }}
-      - name: Publish to Maven Central
+
+      # Deploy artifacts to Maven Central
+      - name: 📦 Publish to Maven Central
         run: mvn --batch-mode -Dmaven.test.skip=true deploy -P gpg-sign -P nexus-staging
 
   # deploy to GitHub Packages
@@ -134,21 +156,28 @@ jobs:
       S3_SBB_POLARION_MAVEN_REPO_RW_SECRET_ACCESS_KEY: ${{ secrets.S3_SBB_POLARION_MAVEN_REPO_RW_SECRET_ACCESS_KEY }}
       GITHUB_TOKEN: ${{ github.token }}
     steps:
-      - name: Set up JDK and Maven
-        uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018 # v4
+      # Set up JDK and Maven
+      - name: 🧱 Set up JDK and Maven
+        uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018  # v4
         with:
           distribution: adopt
           java-version: 17
-      - name: Cache
-        id: cache
+
+      # Restore cache using cache key
+      - name: 💾 Restore Cache
+        id: restore-cache
         uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9  # v4
         with:
           path: |
             /home/runner/.m2
             /home/runner/work
           key: ${{ needs.build.outputs.cache_key }}
-      - name: Publish to GitHub Packages
+
+      # Deploy artifacts to GitHub Packages
+      - name: 📦 Publish to GitHub Packages
         run: mvn --batch-mode -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dmaven.source.skip=true deploy -P deploy-github-packages
-      - name: Upload assets
-        run: cd ${{github.workspace}} && gh release upload v${{ needs.build.outputs.project_version }} target/*-${{ needs.build.outputs.project_version }}.jar
-        shell: bash
+
+      # Upload assets to GitHub Release
+      - name: 📦 Upload assets
+        run: |-
+          gh release upload v${{ needs.build.outputs.project_version }} **/target/*-${{ needs.build.outputs.project_version }}.jar