Add workflow to build java jars

.github/workflows/release.yaml → .github/workflows/release-go.yaml

@@ -1,4 +1,4 @@
-name: Build and release binaries
+name: Release go binaries
 
 on:
   release:
@@ -30,7 +30,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           file: "./src-go/server/build/*"
-          delete_file: "build/*.h"
+          delete_file: "./src-go/server/build/*.h"
           tags: true
           draft: false
           update_latest_release: true

.github/workflows/release-java.yaml

@@ -0,0 +1,29 @@
+name: Release java jars
+
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    name: Create java jars
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK
+        uses: actions/setup-java@v2
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+      - name: Execute Gradle build
+        run: ./gradlew fatJar
+      - name: Upload to GitHub releases
+        uses: xresloader/upload-to-github-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          file: "./build/libs/*.jar"
+          tags: true
+          draft: false
+          update_latest_release: true

README.md

@@ -16,6 +16,14 @@ This magic header is stripped from the request before it's forwarded to the dest
 
 Another option would've been to code an upstream proxy server and connect burp to it, but I personally wanted an extension because it's customizable at runtime and more portable. 
 
+## Installation
+You'll need to download at least 2 files from the [releases](https://github.com/sleeyax/burp-awesome-tls/releases) page:
+The extension itself (.jar) and the local server binary (extension depends on your platform and arch).
+Make sure to rename the local server binary to `server.{EXT}`, where `{EXT}` is your platform's extension, e.g `server.dll` and place it somewhere in `PATH` OR at the same location where you downloaded the extension .jar file to.
+
+Semantic versioning is applied here and significant changes to the extension GUI are considered major. 
+This way you only need to swap out the server binaries when new minor versions are released.
+
 ## Manual build Instructions
 This extension was developed with JetBrains IntelliJ (and GoLand) IDE. 
 The build instructions below assume you're using the same tools to build.