fix: update workflow and publish to maven central (#65)

SchweizerischeBundesbahnen · Sep 13, 2024 · 2b194b9 · 2b194b9
1 parent 76504cb
commit 2b194b9
Show file tree

Hide file tree

Showing 2 changed files with 110 additions and 43 deletions.
diff --git a/.github/workflows/maven-build.yml b/.github/workflows/maven-build.yml
@@ -13,25 +13,36 @@ 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 }}
       GITHUB_TOKEN: ${{ github.token }}
+      SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
       MARKDOWN2HTML_MAVEN_PLUGIN_FAIL_ON_ERROR: true
     steps:
-      - name: Checkout
+      - name: 📄 Checkout the repository
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4
+        with:
+          fetch-depth: 0
       - name: Set up JDK and Maven
-        uses: actions/setup-java@2dfa2011c5b2a0f1489bf9e433881c92c1631f88 # v4
+        uses: actions/setup-java@2dfa2011c5b2a0f1489bf9e433881c92c1631f88  # v4
         with:
           distribution: adopt
           java-version: 17
           gpg-private-key: ${{ secrets.COM_SONATYPE_CENTRAL_POLARION_OPENSOURCE_GPG_PRIVATE_KEY }}
-      - name: Prepare Cache
+      - name: 📝 Get the 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.sha }}" >> $GITHUB_OUTPUT
+      - name: 💾 Prepare cache using cache key
         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 }}
+      - name: 🔘 Generate settings.xml for Maven
         uses: whelk-io/maven-settings-xml-action@9dc09b23833fa9aa7f27b63db287951856f3433d  # v22
         with:
           repositories: >
@@ -78,23 +89,15 @@ jobs:
                 }
               }
             ]
-      - name: Print settings.xml
+      - name: 🔘 Print settings.xml
         run: cat /home/runner/.m2/settings.xml
-      - 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
+      - name: 📦 Build with Maven
+        run: mvn --batch-mode clean package  # sonar:sonar
     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
@@ -106,21 +109,21 @@ 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@2dfa2011c5b2a0f1489bf9e433881c92c1631f88 # v4
+      - name: 🧱 Set up JDK and Maven
+        uses: actions/setup-java@2dfa2011c5b2a0f1489bf9e433881c92c1631f88  # v4
         with:
           distribution: adopt
           java-version: 17
           gpg-private-key: ${{ secrets.COM_SONATYPE_CENTRAL_POLARION_OPENSOURCE_GPG_PRIVATE_KEY }}
-      - name: Restore Cache
+      - name: 💾 Restore cache using cache key
         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
+      - name: 📦 Deploy artifacts to Maven Central
         run: mvn --batch-mode -Dmaven.test.skip=true deploy -P gpg-sign -P nexus-staging
 
   # deploy to GitHub Packages
@@ -136,23 +139,22 @@ 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@2dfa2011c5b2a0f1489bf9e433881c92c1631f88 # v4
+      - name: 🧱 Set up JDK and Maven
+        uses: actions/setup-java@2dfa2011c5b2a0f1489bf9e433881c92c1631f88  # v4
         with:
           distribution: adopt
           java-version: 17
-      - name: Cache
-        id: cache
+      - name: 💾 Restore cache using cache key
+        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
+      - name: 📦 Deploy artifacts 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
+      - name: 📦 Upload assets to GitHub Release
+        run: |-
+          gh release upload v${{ needs.build.outputs.project_version }} target/*-${{ needs.build.outputs.project_version }}.jar
diff --git a/pom.xml b/pom.xml
@@ -6,15 +6,44 @@
     <artifactId>html5diff</artifactId>
     <version>1.4.3-SNAPSHOT</version>
 
+    <name>HTML5Diff</name>
+    <description>Visual comparison of HTML in Java. Fork of DaisyDiff/DaisyDiff</description>
+    <url>https://github.com/SchweizerischeBundesbahnen/html5diff</url>
+
     <licenses>
         <license>
             <name>Apache License Version 2.0, January 2004</name>
             <url>http://www.apache.org/licenses/</url>
         </license>
     </licenses>
 
+    <developers>
+        <developer>
+            <name>SBB Polarion Team</name>
+            <email>polarion-opensource@sbb.ch</email>
+            <organization>SBB AG</organization>
+            <organizationUrl>https://www.sbb.ch</organizationUrl>
+        </developer>
+    </developers>
+
+    <scm>
+        <connection>scm:git:git://github.com/SchweizerischeBundesbahnen/html5diff.git</connection>
+        <developerConnection>scm:git:ssh://github.com/SchweizerischeBundesbahnen/html5diff.git</developerConnection>
+        <url>https://github.com/SchweizerischeBundesbahnen/html5diff/tree/main</url>
+    </scm>
+
+    <issueManagement>
+        <system>GitHub</system>
+        <url>https://github.com/SchweizerischeBundesbahnen/html5diff/issues</url>
+    </issueManagement>
+
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+
+        <maven-gpg-plugin.version>3.2.5</maven-gpg-plugin.version>
+
+        <nexus-staging-maven-plugin.version>1.7.0</nexus-staging-maven-plugin.version>
+        <nexus-staging-maven-plugin.autoReleaseAfterClose>true</nexus-staging-maven-plugin.autoReleaseAfterClose>
     </properties>
 
     <dependencyManagement>
@@ -66,20 +95,29 @@
                 </repository>
             </distributionManagement>
         </profile>
+
         <profile>
-            <id>repsyDeploy</id>
-            <distributionManagement>
-                <repository>
-                    <id>repsy</id>
-                    <name>repsy.io</name>
-                    <url>https://repo.repsy.io/mvn/sbb/sbb</url>
-                </repository>
-                <snapshotRepository>
-                    <id>repsy</id>
-                    <name>repsy.io</name>
-                    <url>https://repo.repsy.io/mvn/sbb/sbb</url>
-                </snapshotRepository>
-            </distributionManagement>
+            <id>gpg-sign</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-gpg-plugin</artifactId>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+
+        <profile>
+            <id>nexus-staging</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.sonatype.plugins</groupId>
+                        <artifactId>nexus-staging-maven-plugin</artifactId>
+                    </plugin>
+                </plugins>
+            </build>
         </profile>
     </profiles>
 
@@ -106,6 +144,33 @@
                     <artifactId>maven-jar-plugin</artifactId>
                     <version>3.4.2</version>
                 </plugin>
+
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-gpg-plugin</artifactId>
+                    <version>${maven-gpg-plugin.version}</version>
+                    <executions>
+                        <execution>
+                            <id>sign-artifacts</id>
+                            <phase>verify</phase>
+                            <goals>
+                                <goal>sign</goal>
+                            </goals>
+                        </execution>
+                    </executions>
+                </plugin>
+
+                <plugin>
+                    <groupId>org.sonatype.plugins</groupId>
+                    <artifactId>nexus-staging-maven-plugin</artifactId>
+                    <version>${nexus-staging-maven-plugin.version}</version>
+                    <extensions>true</extensions>
+                    <configuration>
+                        <serverId>ossrh</serverId>
+                        <nexusUrl>https://oss.sonatype.org/</nexusUrl>
+                        <autoReleaseAfterClose>${nexus-staging-maven-plugin.autoReleaseAfterClose}</autoReleaseAfterClose>
+                    </configuration>
+                </plugin>
             </plugins>
         </pluginManagement>