Embed version in executable and expose version in API and frontend

backend/.goreleaser.yml

@@ -30,7 +30,7 @@ builds:
       - -s
       - -w
       # Embed version
-      - -X main.version={{.Version}}
+      - -X github.com/tfabritius/plainpage/build.version={{.Version}}
 
 archives:
   - name_template: >-

backend/build/build.go

@@ -0,0 +1,22 @@
+package build
+
+import "runtime/debug"
+
+// version will be set via flag at build time
+var version = "dev"
+
+func GetVersion() string {
+	return version
+}
+
+func GetRevision() string {
+	info, _ := debug.ReadBuildInfo()
+
+	for _, kv := range info.Settings {
+		if kv.Key == "vcs.revision" {
+			return kv.Value
+		}
+	}
+
+	return ""
+}

backend/main.go

@@ -13,6 +13,7 @@ import (
 	"time"
 
 	"github.com/joho/godotenv"
+	"github.com/tfabritius/plainpage/build"
 	"github.com/tfabritius/plainpage/server"
 	"github.com/tfabritius/plainpage/service"
 )
@@ -41,6 +42,8 @@ func getDataDir() string {
 }
 
 func main() {
+	log.Printf("📄 Plainpage %s\n", build.GetVersion())
+
 	if err := godotenv.Load(); err != nil && !errors.Is(err, fs.ErrNotExist) {
 		log.Fatalln("Error loading .env file:", err)
 	}

backend/model/api.go

@@ -27,6 +27,7 @@ type GetAppResponse struct {
 	SetupMode     bool   `json:"setupMode"`
 	AllowRegister bool   `json:"allowRegister"`
 	AllowAdmin    bool   `json:"allowAdmin"`
+	Version       string `json:"version"`
 	GitSha        string `json:"gitSha"`
 }
 

backend/server/config.go

@@ -3,25 +3,13 @@ package server
 import (
 	"encoding/json"
 	"net/http"
-	"runtime/debug"
 
 	"github.com/go-chi/render"
+	"github.com/tfabritius/plainpage/build"
 	"github.com/tfabritius/plainpage/model"
 	"github.com/tfabritius/plainpage/service/ctxutil"
 )
 
-func getRevision() string {
-	info, _ := debug.ReadBuildInfo()
-
-	for _, kv := range info.Settings {
-		if kv.Key == "vcs.revision" {
-			return kv.Value
-		}
-	}
-
-	return ""
-}
-
 func (app App) exposeConfig(w http.ResponseWriter, r *http.Request) {
 	userID := ctxutil.UserID(r.Context())
 
@@ -33,14 +21,13 @@ func (app App) exposeConfig(w http.ResponseWriter, r *http.Request) {
 		panic(err)
 	}
 
-	gitSha := getRevision()
-
 	response := model.GetAppResponse{
 		AppTitle:      cfg.AppTitle,
 		SetupMode:     cfg.SetupMode,
 		AllowRegister: allowRegister,
 		AllowAdmin:    allowAdmin,
-		GitSha:        gitSha,
+		GitSha:        build.GetRevision(),
+		Version:       build.GetVersion(),
 	}
 
 	render.JSON(w, r, response)

frontend/pages/_admin/settings.vue

@@ -14,7 +14,7 @@ const { t } = useI18n()
 useHead({ title: t('configuration') })
 
 const app = useAppStore()
-const { gitSha } = storeToRefs(app)
+const { version } = storeToRefs(app)
 
 const { data, error, refresh } = await useAsyncData('/config', () => apiFetch<Config>('/config'))
 
@@ -70,7 +70,7 @@ async function onSave() {
       </ElFormItem>
       <ElFormItem :label="$t('version')">
         <ElInput
-          :value="gitSha" disabled
+          :value="version" disabled
         />
       </ElFormItem>
     </ElForm>

frontend/store/app.ts

@@ -14,13 +14,13 @@ export const useAppStore = defineStore(
     const appTitle = computed(() => data.value?.appTitle ?? 'PlainPage')
     const allowAdmin = computed(() => data.value?.allowAdmin || false)
     const allowRegister = computed(() => data.value?.allowRegister ?? false)
-    const gitSha = computed(() => data.value?.gitSha ?? '')
+    const version = computed(() => data.value?.version ?? '')
 
     return {
       appTitle,
       allowAdmin,
       allowRegister,
-      gitSha,
+      version,
       refresh,
     }
   },

frontend/types/api.ts

@@ -10,6 +10,7 @@ export interface GetAppResponse {
   setupMode: boolean
   allowRegister: boolean
   allowAdmin: boolean
+  version: string
   gitSha: string
 }