Initial Setup

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Release
+name: Build Status
 
 on:
   push:

README.md

@@ -1,6 +1,30 @@
-# **KETE**
-
-> **K**eycloak **E**vents **T**o **E**verywhere is a flexible, high-performance Keycloak extension that streams matched events to various destinations, in various formats.
+<p align="center">
+  <img src="https://raw.githubusercontent.com/FortuneN/kete/release/logo/png/kete-hexagon-128.png" alt="KETE Logo" width="128" height="128">
+</p>
+
+<h1 align="center">
+  <strong>KETE</strong>
+</h1>
+
+<p align="center">
+  Keycloak Events To Everywhere<br>
+  A flexible, high-performance Keycloak extension that streams matched events to various destinations, in various formats.
+</p>
+
+<p align="center">
+  <a href="https://github.com/FortuneN/kete/actions/workflows/release.yml"><img src="https://github.com/FortuneN/kete/actions/workflows/release.yml/badge.svg" alt="Build Status"></a>
+  <a href="https://github.com/FortuneN/kete/releases/latest"><img src="https://img.shields.io/github/v/release/FortuneN/kete?label=Release" alt="Latest Release"></a>
+  <a href="https://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue" alt="Apache 2.0 License"></a>
+</p>
+
+<p align="center">
+  <a href="https://fortunen.github.io/kete/user-guide/overview">User Guide</a> •
+  <a href="https://fortunen.github.io/kete/developer-guide/overview">Developer Guide</a> •
+  <a href="https://github.com/FortuneN/kete/releases">Releases</a> •
+  <a href="https://github.com/FortuneN/kete/tree/release/quick-starts">Quick Starts</a>
+</p>
+
+---
 
 ## Use Cases
 
@@ -28,7 +52,7 @@
 
 ## Quick Start (5 minutes)
 
-### Step 1: [Download](https://raw.githubusercontent.com/FortuneN/kete/release/quick-starts/amqp-0.9.1-rabbitmq/docker-compose.yml) or create docker-compose.yml
+### Step 1: <a href="https://raw.githubusercontent.com/FortuneN/kete/release/quick-starts/amqp-0.9.1-rabbitmq/docker-compose.yml" download>Download</a> or create docker-compose.yml
 
 ```yaml
 services:
@@ -101,7 +125,7 @@ docker compose up -d
 
 ## License
 
-[Apache License 2.0 →](https://www.apache.org/licenses/LICENSE-2.0)
+[Apache 2.0 →](https://www.apache.org/licenses/LICENSE-2.0)
 
 ## Issues
 

run-on-release-push.ps1

@@ -154,7 +154,7 @@ function Test-PreviousStepsPassed {
 # Main Script
 # -----------------------------------------------------------------------------
 
-Write-Banner "KETE │ Release Push" "Creating production release v$($script:Version)" "Green"
+Write-Banner "KETE │ Release Push" "Creating production release $($script:Version)" "Green"
 
 Write-Host ""
 Write-Host "  ┌─────────────────────────────────────────────────────────────────────────┐" -ForegroundColor DarkGreen
@@ -368,7 +368,7 @@ if (-not (Test-PreviousStepsPassed)) {
 } else {
 
     $stepStart = Get-Date
-    $tagName = "v$($script:Version)"
+    $tagName = "$($script:Version)"
 
     Write-Task "Creating Git tag $tagName..."
     git tag -a $tagName -m "Release $tagName" 2>&1 | Out-Null
@@ -387,27 +387,7 @@ if (-not (Test-PreviousStepsPassed)) {
 
     if ($script:Results["5. Git Tag"]) {
         Write-Task "Creating GitHub Release..."
-
-        $releaseNotes = @"
-## KETE Release $tagName
-
-### 📦 Artifact
-
-``kete.jar`` - Keycloak Event Transmitter Extension
-
-> Version $($script:Version) is imprinted in META-INF/MANIFEST.MF
-
-### 🚀 Quick Start
-
-``````bash
-curl -sSL https://raw.githubusercontent.com/FortuneN/kete/release/quick-starts/http-webhook/docker-compose.yml | docker compose -f - up
-``````
-
-### 📚 Documentation
-
-https://fortunen.github.io/kete/
-"@
-
+        $releaseNotes = ""
         gh release create $tagName --title "$tagName" --notes $releaseNotes "target/$script:JarName" 2>&1 | Out-Null
         $releaseCreated = $LASTEXITCODE -eq 0
         Write-TaskResult "GitHub Release $tagName" $releaseCreated
@@ -433,7 +413,7 @@ Write-Host ""
 Write-Host ""
 Write-Host ("═" * 80) -ForegroundColor Green
 Write-Host ""
-Write-Host "  RELEASE SUMMARY │ v$($script:Version)" -ForegroundColor Green
+Write-Host "  RELEASE SUMMARY │ $($script:Version)" -ForegroundColor Green
 Write-Host ""
 Write-Host ("═" * 80) -ForegroundColor Green
 
@@ -445,7 +425,7 @@ Write-Host ""
 if ($failedCount -eq 0) {
 
     Write-Host "  Release Artifact:" -ForegroundColor White
-    Write-Host "    kete.jar (v$($script:Version))" -ForegroundColor Cyan
+    Write-Host "    kete.jar ($($script:Version))" -ForegroundColor Cyan
     Write-Host ""
     Write-Host "  Docker Images Published:" -ForegroundColor DarkGray
 
@@ -458,12 +438,12 @@ if ($failedCount -eq 0) {
     Write-Host "    https://fortunen.github.io/kete/" -ForegroundColor DarkGray
     Write-Host ""
     Write-Host "  GitHub Release:" -ForegroundColor White
-    Write-Host "    https://github.com/FortuneN/kete/releases/tag/v$($script:Version)" -ForegroundColor Gray
+    Write-Host "    https://github.com/FortuneN/kete/releases/tag/$($script:Version)" -ForegroundColor Gray
     Write-Host ""
     Write-Host ""
     Write-Host "  ╔══════════════════════════════════════════════════════════════════════╗" -ForegroundColor Green
     Write-Host "  ║                                                                      ║" -ForegroundColor Green
-    Write-Host "  ║   ✓  RELEASE v$($script:Version) PUBLISHED SUCCESSFULLY                   ║" -ForegroundColor Green
+    Write-Host "  ║   ✓  RELEASE $($script:Version) PUBLISHED SUCCESSFULLY                    ║" -ForegroundColor Green
     Write-Host "  ║                                                                      ║" -ForegroundColor Green
     Write-Host "  ╚══════════════════════════════════════════════════════════════════════╝" -ForegroundColor Green