Adds version information to the software:

- adds version flag which is printed on startup
- adds build information (version, commit hash) to grpc server info structure

Author: nwaldispuehl

.github/workflows/build.yml

@@ -43,6 +43,9 @@ jobs:
           cache-to: type=gha,mode=max
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ github.head_ref }}
+            COMMIT=${{ github.sha }}
 
       - name: Inspect Docker image
         run: docker image inspect ${{ steps.meta.outputs.tags }}

.github/workflows/publish.yml

@@ -54,3 +54,6 @@ jobs:
           cache-to: type=gha,mode=max
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ github.head_ref }}
+            COMMIT=${{ github.sha }}

Dockerfile

@@ -12,6 +12,8 @@ FROM golang:1.20.5-alpine as server
 RUN apk add --no-cache gcc musl-dev
 WORKDIR /code
 ENV CGO_ENABLED=1
+ARG VERSION=development
+ARG COMMIT="-"
 COPY ./go.mod ./
 COPY ./go.sum ./
 RUN go mod download
@@ -21,6 +23,9 @@ COPY ./main.go ./main.go
 COPY ./cmd/ ./cmd/
 COPY ./pkg/ ./pkg/
 COPY ./internal/ ./internal/
+COPY ./buildinfo/ ./buildinfo/
+RUN echo "Using: Version: ${VERSION}, Commit: ${COMMIT}"
+RUN go generate buildinfo/buildinfo.go
 RUN go build -o wg-access-server
 
 ### Server

buildinfo/buildinfo.go

@@ -0,0 +1,29 @@
+package buildinfo
+
+import (
+    "strings"
+   _ "embed"
+)
+
+//go:generate sh get_version.sh
+//go:embed version.txt
+var VersionRaw string
+
+//go:generate sh get_commit.sh
+//go:embed commit.txt
+var CommitHashRaw string
+
+func Version() string {
+    return strings.TrimSpace(VersionRaw)
+}
+
+func CommitHash() string {
+    return strings.TrimSpace(CommitHashRaw)
+}
+
+func ShortCommitHash() string {
+    if 7 < len(CommitHash()) {
+        return CommitHash()[0:7]
+    }
+    return CommitHash()
+}

buildinfo/commit.txt

@@ -0,0 +1 @@
+-

buildinfo/get_commit.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+if [ -z "${COMMIT}" ]; then
+    echo "-" > commit.txt
+else
+    echo "${COMMIT}" > commit.txt
+fi

buildinfo/get_version.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+if  [ -z "$VERSION" ] ; then
+    echo "development" > version.txt
+else
+    echo "${VERSION}" > version.txt
+fi

buildinfo/version.txt

@@ -0,0 +1 @@
+development

cmd/serve/main.go

@@ -33,6 +33,7 @@ import (
 	"github.com/freifunkMUC/wg-access-server/internal/storage"
 	"github.com/freifunkMUC/wg-access-server/pkg/authnz"
 	"github.com/freifunkMUC/wg-access-server/pkg/authnz/authconfig"
+	"github.com/freifunkMUC/wg-access-server/buildinfo"
 )
 
 func Register(app *kingpin.Application) *servecmd {
@@ -80,6 +81,9 @@ func (cmd *servecmd) Name() string {
 func (cmd *servecmd) Run() {
 	conf := cmd.ReadConfig()
 
+	// Software banner
+	logrus.Infof("+++ wg-access-server %s (%s)", buildinfo.Version(), buildinfo.ShortCommitHash())
+
 	// Get the server's IP addresses within the VPN
 	var vpnip, vpnipv6 netip.Prefix
 	var err error
@@ -125,7 +129,7 @@ func (cmd *servecmd) Run() {
 		defer wgimpl.Close()
 		wg = wgimpl
 
-		logrus.Infof("Starting WireGuard server on :%d", conf.WireGuard.Port)
+		logrus.Infof("Starting WireGuard on :%d", conf.WireGuard.Port)
 
 		wgconfig := &wgembed.ConfigFile{
 			Interface: wgembed.IfaceConfig{

internal/services/server_service.go

@@ -13,6 +13,7 @@ import (
 	"github.com/freifunkMUC/wg-access-server/internal/network"
 	"github.com/freifunkMUC/wg-access-server/pkg/authnz/authsession"
 	"github.com/freifunkMUC/wg-access-server/proto/proto"
+	"github.com/freifunkMUC/wg-access-server/buildinfo"
 )
 
 type ServerService struct {
@@ -73,6 +74,7 @@ func (s *ServerService) Info(ctx context.Context, req *proto.InfoReq) (*proto.In
 		ClientConfigDnsServers:        clientConfigDnsServers(s.Config),
 		ClientConfigDnsSearchDomain:   s.Config.ClientConfig.DNSSearchDomain,
 		ClientConfigMtu:               int32(s.Config.ClientConfig.MTU),
+		BuildInfo:                     &proto.BuildInfo{Version: buildinfo.Version(), Commit: buildinfo.ShortCommitHash()},
 	}, nil
 }
 

proto/buildinfo.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package proto;
+
+option go_package = "github.com/freifunkMUC/wg-access-server/proto/proto";
+
+message BuildInfo {
+  string version = 1;
+  string commit = 2;
+}