add release workflow

Author: Revolyssup

.github/workflows/release.yaml

@@ -0,0 +1,50 @@
+name: Release Build
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build Binaries
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    
+    strategy:
+      matrix:
+        goos: [linux, darwin, windows]
+        goarch: ["amd64", "arm64"]
+      fail-fast: false
+    
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: "1.21"
+
+    - name: Build Binary
+      env:
+        GOOS: ${{ matrix.goos }}
+        GOARCH: ${{ matrix.goarch }}
+      run: |
+        OUTPUT_NAME="k8sdebug-${{ matrix.goos }}-${{ matrix.goarch }}"
+        if [ "${{ matrix.goos }}" = "windows" ]; then
+          OUTPUT_NAME="$OUTPUT_NAME.exe"
+        fi
+        go build -trimpath -ldflags="-s -w" -o $OUTPUT_NAME main.go
+        mkdir dist
+        mv $OUTPUT_NAME dist/
+
+    - name: Upload Release Asset
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ github.event.release.upload_url }}
+        asset_path: ./dist/k8sdebug-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.goos == 'windows' && '.exe' || '' }}
+        asset_name: k8sdebug-${{ matrix.goos }}-${{ matrix.goarch }}${{ matrix.goos == 'windows' && '.exe' || '' }}
+        asset_content_type: application/octet-stream

README.md

@@ -4,9 +4,12 @@
 
 This tool is created to solve my personal pain points while debugging an application inside K8s environment. This tool is not written from the perspective of a devops engineer but rather from the perspective of a backend application engineer trying to debug issues with the application in k8s environment. This tool is not created to be used directly with production environments. It expects certain privileges that might not be available in production. The audience for this is specifically developers running dev clusters or local clusters while debugging an application related issue. Any future feature that may be added will respect the above fact and not go beyond that scope. There might be mature tools available already that might have some intersection with the features provided here but most of those tools are devops centric. This tool is primarily application centric.
 
-## Features
+**⚠️ Production Warning**  
+This tool requires elevated privileges and is intended for development clusters only. Never use in production environments.
 
-####  1. Persistent Log analysis
+## 🚀 Features
+
+### 🔍 Persistent Log Analysis
 
 **Problem Addressed:**
 Kubernetes does **not** store logs of deleted pods by default. Tools like `kubectl logs` only work for existing pods. Existing solutions (e.g., Loki, Elasticsearch) require complex log aggregation setups.
@@ -18,10 +21,16 @@ k8sdebug runs a daemon to persistently capture logs for all pods in a namespace
 **Usage**
 
 ```bash
-k8sdebug logs record start -n <namespace>
-```
+# Start recording logs in a namespace
+k8sdebug logs record start -n my-namespace
 
-This will start a dameon process that will record logs from all pods in that namespace and persist it on filesystem (by default in /tmp). Later the logs can be analyzed with following command.
+# Compare logs across deployment pods
+k8sdebug logs diff -n my-ns --type deployment --tail 20 my-app
+
+# Manage log storage
+k8sdebug logs setpath ~/debug-logs  # Change storage location
+k8sdebug logs cleanup --hard        # Remove all logs
+```
 
 ``` bash
 k8sdebug logs diff -n <namespace> --type deployment --tail 20(default) <name of deployment>
@@ -70,13 +79,39 @@ PATH=/home/ashish/k8sdebug.
 
 First time the k8sdebug command is called this file will be created.
 
-## Progress
 
-- [x] Persistent Log analysis
-- [x] Smart port forwarding
-- [ ] In-cluster connectivity testing.
-- [ ] `kubebox`
-- [ ] Traffic recording and visualisation
+### 🔄 Smart Port Forwarding
+
+```bash
+k8sdebug port-forward \
+  -n my-namespace \
+  --labels "app=backend" \
+  --policy round-robin \
+  --hostport 8080 \
+  --containerport 80
+
+# Supported policies:
+# - round-robin (default)
+
+```
+🤝 Contributing
+I welcome contributions that align with our scope:
+
+Open an issue to discuss proposed changes
+
+Maintain comprehensive test coverage
+
+Document new features clearly
+
+## 📅 Development Roadmap
+
+| Feature                | Status     | Version Target |
+|------------------------|------------|----------------|
+| Log Aggregation          | ✅ Stable  | v0.1.0         |
+| Port Forward Policies  | ✅ Stable  | v0.1.0         |
+| Local Dev Simulatio(Kubebox)   | Planned    | v0.3.0         |
+| Connectivity Testing   | Planned | v0.4.0         |
+| Traffic Visualization  | Planned    | v0.5.0         |
 
 ## License
 

go.mod

@@ -7,6 +7,7 @@ toolchain go1.23.8
 require (
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2
 	github.com/spf13/cobra v1.9.1
+	github.com/stretchr/testify v1.9.0
 	k8s.io/api v0.32.3
 	k8s.io/apimachinery v0.32.3
 	k8s.io/client-go v0.32.3