feat: prepare for automatic releasing

Author: Neunerlei

.github/workflows/release.yml

@@ -0,0 +1,31 @@
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Make build script executable
+        run: chmod +x ./build.sh
+
+      - name: Run build script
+        run: ./build.sh
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: ./target/hawk-auth-server-extension.jar
+          name: Release ${{ github.ref_name }}
+          draft: false
+          prerelease: false
+          token: ${{ secrets.GITHUB_TOKEN }}
+          generate_release_notes: true

.gitignore

@@ -10,5 +10,3 @@
 
 .maven/*
 target/*
-!target/hawk-auth-server-extension.jar
-!target/hawk-auth-server-extension-sources.jar

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2025 HAWK Hildesheim
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

build.sh

@@ -2,8 +2,14 @@
 
 SCRIPT_FILE=$(realpath ${BASH_SOURCE%/*})
 cd $SCRIPT_FILE
+
+VERSION="0.0.1"
+if [ -n "$1" ]; then
+  VERSION=$1
+fi
+
 docker run --rm \
   -v "$PWD":/usr/src/mymaven \
   -v "$PWD/.maven":/root/.m2 \
   -w /usr/src/mymaven \
-  maven:3 mvn clean install
+  maven:3 mvn -DpackageVersion=${VERSION} clean install

pom.xml

@@ -3,7 +3,6 @@
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
-
     <name>HAWK Auth Server</name>
     <description>Keycloak extension that provides some additional REST endpoints for more efficient work with the client library</description>
 
@@ -15,7 +14,7 @@
 
     <groupId>com.hawk.keycloak</groupId>
     <artifactId>hawk-auth-server-extension</artifactId>
-    <version>26.0.4</version>
+    <version>${packageVersion}</version>
     <packaging>jar</packaging>
 
     <properties>
@@ -29,26 +28,55 @@
         <dependency>
             <groupId>org.keycloak</groupId>
             <artifactId>keycloak-core</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-common</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-model-storage</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-model-storage-private</artifactId>
+            <version>${keycloak.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.keycloak</groupId>
+            <artifactId>keycloak-config-api</artifactId>
+            <version>${keycloak.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.keycloak</groupId>
             <artifactId>keycloak-server-spi</artifactId>
+            <version>${keycloak.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.keycloak</groupId>
             <artifactId>keycloak-server-spi-private</artifactId>
+            <version>${keycloak.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.keycloak</groupId>
             <artifactId>keycloak-services</artifactId>
+            <version>${keycloak.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.keycloak</groupId>
             <artifactId>keycloak-saml-core-public</artifactId>
+            <version>${keycloak.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
@@ -77,6 +105,12 @@
 
     <build>
         <finalName>${project.artifactId}</finalName>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

src/main/java/com/hawk/keycloak/util/ConnectionInfoRequestHandler.java

@@ -16,7 +16,7 @@ public ConnectionInfo handleRequest() {
 
         return new ConnectionInfo(
                 Version.VERSION,
-                "1.0.0",
+                VersionInfo.getPackageVersion(),
                 session.getContext().getClient().getClientId(),
                 session.getContext().getClient().getId()
         );

src/main/java/com/hawk/keycloak/util/VersionInfo.java

@@ -0,0 +1,34 @@
+package com.hawk.keycloak.util;
+
+import lombok.extern.slf4j.Slf4j;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
+
+@Slf4j
+public class VersionInfo {
+
+    private static final String PACKAGE_VERSION;
+
+    static {
+        String version;
+        Properties properties = new Properties();
+        try (InputStream input = VersionInfo.class.getClassLoader().getResourceAsStream("version.properties")) {
+            if (input != null) {
+                properties.load(input);
+                version = properties.getProperty("version", "unknown");
+            } else {
+                version = "unknown";
+            }
+        } catch (IOException e) {
+            log.error("Failed to read version.properties", e);
+            version = "unknown";
+        }
+        PACKAGE_VERSION = version;
+    }
+
+    public static String getPackageVersion() {
+        return PACKAGE_VERSION;
+    }
+}

src/main/resources/version.properties

@@ -0,0 +1 @@
+version=${packageVersion}