Setup Github Release automation (#29)

* Setup Github Release automation

* Fix config file

* Add gitignore

* Apply suggestion from @sjmiller609

* Also publish helper script

Author: sjmiller609

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release Hypeman API
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: [self-hosted, linux, x64, kvm]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.25'
+
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v6
+        with:
+          # gorelease-pro is not required
+          distribution: goreleaser
+          version: '~> v2'
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -23,3 +23,4 @@ lib/system/exec_agent/exec-agent
 
 # Envoy binaries
 lib/ingress/binaries/envoy/*/*/envoy
+dist/**

.goreleaser.yaml

@@ -0,0 +1,70 @@
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+version: 2
+
+before:
+  hooks:
+    - make release-prep
+
+builds:
+  - id: hypeman-api
+    main: ./cmd/api
+    binary: hypeman-api
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+    goarch:
+      - amd64
+      - arm64
+    tags:
+      - containers_image_openpgp
+    ldflags:
+      - -s -w
+      - -X main.version={{.Version}}
+      - -X main.commit={{.Commit}}
+      - -X main.date={{.Date}}
+
+  - id: hypeman-token
+    main: ./cmd/gen-jwt
+    binary: hypeman-token
+    env:
+      - CGO_ENABLED=0
+    goos:
+      - linux
+    goarch:
+      - amd64
+      - arm64
+    ldflags:
+      - -s -w
+
+archives:
+  - id: default
+    formats:
+      - tar.gz
+    name_template: >-
+      {{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}
+    files:
+      - LICENSE
+      - README.md
+      - RELEASES.md
+
+checksum:
+  name_template: 'checksums.txt'
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'
+      - '^ci:'
+      - '^chore:'
+      - Merge pull request
+      - Merge branch
+
+release:
+  github:
+    owner: onkernel
+    name: hypeman
+  prerelease: auto
+  draft: false

Makefile

@@ -1,5 +1,5 @@
 SHELL := /bin/bash
-.PHONY: oapi-generate generate-vmm-client generate-wire generate-all dev build test install-tools gen-jwt download-ch-binaries download-ch-spec ensure-ch-binaries download-envoy-binaries ensure-envoy-binaries
+.PHONY: oapi-generate generate-vmm-client generate-wire generate-all dev build test install-tools gen-jwt download-ch-binaries download-ch-spec ensure-ch-binaries download-envoy-binaries ensure-envoy-binaries release-prep
 
 # Directory where local binaries will be installed
 BIN_DIR ?= $(CURDIR)/bin
@@ -186,3 +186,8 @@ clean:
 	rm -f lib/exec/exec.pb.go
 	rm -f lib/exec/exec_grpc.pb.go
 	rm -f lib/system/exec_agent/exec-agent
+
+# Prepare for release build (called by GoReleaser)
+# Downloads all embedded binaries and builds embedded components
+release-prep: download-ch-binaries download-envoy-binaries lib/system/exec_agent/exec-agent
+	go mod tidy

RELEASES.md

@@ -0,0 +1,33 @@
+# Releases
+
+## Versioning
+
+This project uses [Semantic Versioning](https://semver.org/).
+
+## Creating a Release
+
+1. Ensure `main` is in a releasable state (CI passing)
+2. Tag the release: `git tag v1.0.0 && git push origin v1.0.0`
+3. GitHub Actions builds binaries and creates the release automatically
+
+## Getting Binaries
+
+### Released Version
+Download from the [Releases](https://github.com/onkernel/hypeman/releases) page.
+
+### Building from Source
+```bash
+git clone https://github.com/onkernel/hypeman
+cd hypeman
+make build
+# Binary at ./bin/hypeman
+```
+
+## Prereleases
+
+For release candidates before major versions, use semver prerelease syntax:
+```
+v2.0.0-rc.1 → v2.0.0-rc.2 → v2.0.0
+```
+
+Prerelease tags are incremented, not replaced.