minor: add a new release system (#3)
All checks were successful
ci/woodpecker/push/push Pipeline was successful
All checks were successful
ci/woodpecker/push/push Pipeline was successful
# Changes * package and release helm charts for the project * configure a new release system based of semver * add changelog entries via keep-a-changelog formatting * add gitea releases Co-authored-by: Madison Grubb <madison@elastiflow.com> Reviewed-on: #3
This commit was merged in pull request #3.
This commit is contained in:
20
README.md
20
README.md
@@ -77,12 +77,30 @@ docker run -p 3000:3000 kestrelos:latest
|
||||
|
||||
## Kubernetes (Helm)
|
||||
|
||||
**From Gitea registry:**
|
||||
```bash
|
||||
helm install kestrelos ./helm/kestrelos --set image.repository=your-registry/kestrelos --set image.tag=latest
|
||||
helm repo add keligrubb --username YOUR_USER --password YOUR_TOKEN https://git.keligrubb.com/api/packages/keligrubb/helm
|
||||
helm repo update
|
||||
helm install kestrelos keligrubb/kestrelos
|
||||
```
|
||||
|
||||
**From source:**
|
||||
```bash
|
||||
helm install kestrelos ./helm/kestrelos
|
||||
```
|
||||
|
||||
Health: `GET /health` (overview), `GET /health/live` (liveness), `GET /health/ready` (readiness). Probes are configured in the Helm chart. Optional: enable Ingress in `helm/kestrelos/values.yaml`.
|
||||
|
||||
## Releases
|
||||
|
||||
Merges to `main` trigger a semver release. Use one of these prefixes in your PR title to set the version bump:
|
||||
|
||||
- `major:` – breaking changes
|
||||
- `minor:` – new features
|
||||
- `patch:` – bug fixes, docs (default if no prefix)
|
||||
|
||||
Example: `minor: Add map layer toggle`
|
||||
|
||||
## Security
|
||||
|
||||
- Device data is validated server-side; only valid entries are returned.
|
||||
|
||||
Reference in New Issue
Block a user