Merge pull request #43 from JVMerkle/feature/git-describe

Use git-describe to determine the version

Author: JVMerkle

Makefile

@@ -1,10 +1,10 @@
 GO ?= go
 PODMAN ?= podman
 
-GITHASH := $(shell git rev-parse --short HEAD)
+GITDESCRIBE := $(shell git describe)
 BUILDTIME := $(shell date -u '+%Y%m%dT%H%M%SZ')
 
-GOLDFLAGS += -X "github.com/JVMerkle/gemportal/app.gitHash=$(GITHASH)"
+GOLDFLAGS += -X "github.com/JVMerkle/gemportal/app.gitDescribe=$(GITDESCRIBE)"
 GOLDFLAGS += -X "github.com/JVMerkle/gemportal/app.buildTime=$(BUILDTIME)"
 GOLDFLAGS += -w -s
 GOFLAGS += -ldflags "$(GOLDFLAGS)"

app/config.go

@@ -19,8 +19,8 @@ var (
 
 // Injected with linker flags
 var (
-	gitHash   string
-	buildTime string
+	gitDescribe   string
+	buildTime     string
 )
 
 type Config struct {
@@ -47,7 +47,7 @@ func (c *Config) GetAppBuildMeta() string {
 }
 
 // GetConfig loads and checks the application configuration
-func GetConfig(appVersion string) (*Config, error) {
+func GetConfig() (*Config, error) {
 	var cfg Config
 
 	// Load environment variables from a ".env" file, if exists
@@ -58,17 +58,17 @@ func GetConfig(appVersion string) (*Config, error) {
 		return nil, err
 	}
 
-	if len(gitHash) == 0 || len(buildTime) == 0 {
-		log.Warn("Link time definitions missing (GitHash/Buildtime)")
+	if len(gitDescribe) == 0 || len(buildTime) == 0 {
+		log.Warn("Link time definitions missing (gitDescribe/Buildtime)")
 	}
 
 	if len(cfg.AppDesc) == 0 {
 		cfg.AppDesc = template.HTML("<b>Simple</b> Gemini HTTP portal for port " + cfg.DefaultPort + ".")
 	}
 
-	buildMeta := []string{gitHash, buildTime}
+	buildMeta := []string{gitDescribe, buildTime}
 
-	cfg.appVersion = appVersion
+	cfg.appVersion = gitDescribe
 
 	for i := 0; i < len(buildMeta); i++ {
 		cfg.appBuildMeta += buildMeta[i]

main.go

@@ -16,8 +16,6 @@ import (
 	"github.com/gorilla/mux"
 )
 
-const AppVersion = "1.0.3"
-
 //go:embed static/style.css
 //go:embed static/app.js
 var staticFS embed.FS
@@ -26,7 +24,7 @@ var staticFS embed.FS
 var templateFS embed.FS
 
 func main() {
-	cfg, err := app.GetConfig(AppVersion)
+	cfg, err := app.GetConfig()
 	if err != nil {
 		log.Fatalf("Could not load config: %s", err.Error())
 	}

templates/index.html

@@ -51,9 +51,9 @@ <h1><a class="title" href="{{ .Cfg.BaseHREF }}">{{ .Cfg.AppName }}</a></h1>
        rel="noreferrer noopener">gemportal</a>
     {{ if .Cfg.GetAppBuildMeta }}
     <span class="version"
-          title="{{ .Cfg.GetAppVersion }}+{{ .Cfg.GetAppBuildMeta }}">v{{ .Cfg.GetAppVersion }}</span>
+          title="{{ .Cfg.GetAppBuildMeta }}">{{ .Cfg.GetAppVersion }}</span>
     {{ else }}
-    <span class="version" title="{{ .Cfg.GetAppVersion }}">v{{ .Cfg.GetAppVersion }}</span>
+    <span class="version" title="{{ .Cfg.GetAppVersion }}">{{ .Cfg.GetAppVersion }}</span>
     {{ end }}
 </footer>
 </body>