From fc29ee9eebb9aea04f856ea78b5e625225945ddf Mon Sep 17 00:00:00 2001
From: Sebastian Nickel <nick@nine.ch>
Date: Wed, 27 May 2026 14:48:30 +0200
Subject: [PATCH] indicate helm releases in release notes

---
 .cr.yaml                            |  1 +
 .github/workflows/chart-release.yml |  1 +
 deploy/helm/kigeon/README.md        | 67 +++++++++++++++++++++++++++++
 deploy/helm/kigeon/RELEASE-NOTES.md |  3 ++
 4 files changed, 72 insertions(+)
 create mode 100644 .cr.yaml
 create mode 100644 deploy/helm/kigeon/README.md
 create mode 100644 deploy/helm/kigeon/RELEASE-NOTES.md

diff --git a/.cr.yaml b/.cr.yaml
new file mode 100644
index 0000000..a61ba83
--- /dev/null
+++ b/.cr.yaml
@@ -0,0 +1 @@
+release-notes-file: RELEASE-NOTES.md
diff --git a/.github/workflows/chart-release.yml b/.github/workflows/chart-release.yml
index 5d37d27..3aebf54 100644
--- a/.github/workflows/chart-release.yml
+++ b/.github/workflows/chart-release.yml
@@ -26,5 +26,6 @@ jobs:
       - uses: helm/chart-releaser-action@v1
         with:
           charts_dir: deploy/helm
+          config: .cr.yaml
         env:
           CR_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/deploy/helm/kigeon/README.md b/deploy/helm/kigeon/README.md
new file mode 100644
index 0000000..549f095
--- /dev/null
+++ b/deploy/helm/kigeon/README.md
@@ -0,0 +1,67 @@
+# kigeon Helm Chart
+
+Deploys [kigeon](https://github.com/ninech/kigeon), a tool for sending Kubernetes events to configurable receivers.
+
+## Installation
+
+```bash
+helm repo add kigeon https://ninech.github.io/kigeon
+helm repo update
+helm install kigeon kigeon/kigeon
+```
+
+## Configuration
+
+All kigeon configuration lives under the `config` key and is rendered verbatim into a ConfigMap. See the [kigeon documentation](https://github.com/ninech/kigeon) for all available options.
+
+### Example: send events to Loki
+
+```yaml
+config:
+  eventsenders:
+    - name: loki
+      type: loki
+      config:
+        url: http://loki.monitoring.svc:3100
+```
+
+### Persistence
+
+By default, the NATS data directory uses an `emptyDir`, meaning deduplication state is lost on pod restart and kigeon may re-send events that were already forwarded. Enable persistence for production use:
+
+```yaml
+persistence:
+  enabled: true
+  size: 1Gi
+```
+
+### Passing secrets via environment variables
+
+Use `extraEnv` to inject secrets (e.g. credentials for a sender):
+
+```yaml
+extraEnv:
+  - name: LOKI_PASSWORD
+    valueFrom:
+      secretKeyRef:
+        name: loki-credentials
+        key: password
+```
+
+## Values
+
+| Key | Default | Description |
+|-----|---------|-------------|
+| `image.repository` | `ghcr.io/ninech/kigeon` | Image repository |
+| `image.tag` | `""` | Image tag (defaults to `.Chart.AppVersion`) |
+| `image.pullPolicy` | `IfNotPresent` | Image pull policy |
+| `serviceAccount.create` | `true` | Create a ServiceAccount |
+| `persistence.enabled` | `false` | Enable persistent storage for NATS data |
+| `persistence.size` | `1Gi` | PVC size |
+| `persistence.storageClass` | `""` | StorageClass name (uses cluster default when empty) |
+| `persistence.existingClaim` | `""` | Use an existing PVC instead of creating one |
+| `extraEnv` | `[]` | Extra environment variables injected into the container |
+| `resources` | `{}` | Container resource requests and limits |
+| `nodeSelector` | `{}` | Node selector |
+| `tolerations` | `[]` | Tolerations |
+| `affinity` | `{}` | Affinity rules |
diff --git a/deploy/helm/kigeon/RELEASE-NOTES.md b/deploy/helm/kigeon/RELEASE-NOTES.md
new file mode 100644
index 0000000..3663e4d
--- /dev/null
+++ b/deploy/helm/kigeon/RELEASE-NOTES.md
@@ -0,0 +1,3 @@
+This release contains the Helm chart for kigeon.
+
+See the [README](https://github.com/ninech/kigeon/blob/main/deploy/helm/kigeon/README.md) for installation and configuration details.