Use Github Actions to make releases

Author: m35

.github/workflows/maven.yml

@@ -1,35 +1,32 @@
-# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Java CI with Maven
+name: Build and Release JAR
 
 on:
   push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
+    tags:
+      - 'v*.*.*'
+
+permissions:
+  contents: write
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up JDK 17
-      uses: actions/setup-java@v3
-      with:
-        java-version: '17'
-        distribution: 'temurin'
-        cache: maven
-    - name: Build with Maven
-      run: mvn -B package --file pom.xml
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '8'
+
+      - name: Build with Maven
+        run: mvn clean package
 
-    # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
-    - name: Update dependency graph
-      uses: advanced-security/maven-dependency-submission-action@571e99aab1055c2e71a1e2309b9691de18d6b7d6
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: target/UnityPackageViewer-*.jar

pom.xml

@@ -12,7 +12,7 @@
     </properties>
 
     <dependencies>
-        <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-compress -->
+        <!-- Only dependency is Apache Commons Compress to read .tar files -->
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-compress</artifactId>
@@ -21,18 +21,35 @@
     </dependencies>
 
     <build>
+
+        <!-- Just put everything in the .jar so it can be distributed as a single file -->
         <resources>
+            <!-- Default resources location -->
             <resource><directory>src/main/resources</directory></resource>
+
+            <!-- Include the source code in the .jar -->
             <resource><directory>src/main/java</directory></resource>
+
+            <!--
+            Include files in src/main/misc/ in the .jar, but also filter them
+            (primarily to put the app version as a property for the app to use)
+            -->
             <resource>
                 <directory>src/main/misc</directory>
                 <filtering>true</filtering>
             </resource>
+
+            <!-- Include the licence file in the .jar -->
             <resource>
                 <directory>.</directory>
                 <includes><include>LICENSE.txt</include></includes>
             </resource>
         </resources>
+
+        <!--
+        Use the Maven Shade plugin to strip out all unused classes
+        and turn everything into a single fat jar.
+        -->
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -48,7 +65,10 @@
                             <finalName>UnityPackageViewer-${project.version}</finalName>
                             <minimizeJar>true</minimizeJar>
 
-                            <!-- Choose my MANIFEST.MF as the winner -->
+                            <!--
+                            Apache Compress .jar also has its own MANIFEST.MF file.
+                            Choose my MANIFEST.MF as the winner
+                            -->
                             <filters>
                                 <filter>
                                     <artifact>${project.groupId}:${project.artifactId}</artifact>
@@ -65,8 +85,11 @@
                             </filters>
 
                             <transformers>
+                                <!--Prevents license duplication -->
                                 <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheLicenseResourceTransformer"/>
+                                <!-- Prepares merged NOTICE -->
                                 <transformer implementation="org.apache.maven.plugins.shade.resource.ApacheNoticeResourceTransformer"/>
+                                <!--Set the main class in the MANIFEST -->
                                 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                     <mainClass>unitypackage.viewer.Main</mainClass>
                                 </transformer>