Merge pull request #170 from blinklabs-io/feat/log-version

feat: log version

Author: wolf31o2

Makefile

@@ -6,14 +6,22 @@ ROOT_DIR=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 # Gather all .go files for use in dependencies below
 GO_FILES=$(shell find $(ROOT_DIR) -name '*.go')
 
+# Extract Go module name from go.mod
+GOMODULE=$(shell grep ^module $(ROOT_DIR)/go.mod | awk '{ print $$2 }')
+
+# Set version strings based on git tag and current ref
+GO_LDFLAGS=-ldflags "-s -w -X '$(GOMODULE)/internal/version.Version=$(shell git describe --tags --exact-match 2>/dev/null)' -X '$(GOMODULE)/internal/version.CommitHash=$(shell git rev-parse --short HEAD)'"
+
 mod-tidy:
 	go mod tidy
 
 # Build our program binary
 # Depends on GO_FILES to determine when rebuild is needed
 $(BINARY): mod-tidy $(GO_FILES)
-	# Needed to fetch new dependencies and add them to go.mod
-	go build -o $(BINARY) ./cmd/$(BINARY)
+	go build \
+		$(GO_LDFLAGS) \
+		-o $(BINARY) \
+		./cmd/$(BINARY)
 
 .PHONY: build clean image mod-tidy
 

cmd/tx-submit-api/main.go

@@ -17,12 +17,14 @@ package main
 import (
 	"flag"
 	"fmt"
-	"github.com/blinklabs-io/tx-submit-api/internal/api"
-	"github.com/blinklabs-io/tx-submit-api/internal/config"
-	"github.com/blinklabs-io/tx-submit-api/internal/logging"
 	"net/http"
 	_ "net/http/pprof"
 	"os"
+
+	"github.com/blinklabs-io/tx-submit-api/internal/api"
+	"github.com/blinklabs-io/tx-submit-api/internal/config"
+	"github.com/blinklabs-io/tx-submit-api/internal/logging"
+	"github.com/blinklabs-io/tx-submit-api/internal/version"
 )
 
 var cmdlineFlags struct {
@@ -57,6 +59,8 @@ func main() {
 		}
 	}()
 
+	logger.Infof("starting tx-submit-api %s", version.GetVersionString())
+
 	// Start debug listener
 	if cfg.Debug.ListenPort > 0 {
 		logger.Infof(

internal/version/version.go

@@ -0,0 +1,31 @@
+// Copyright 2023 Blink Labs Software
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package version
+
+import (
+	"fmt"
+)
+
+// These are populated at build time
+var Version string
+var CommitHash string
+
+func GetVersionString() string {
+	if Version != "" {
+		return fmt.Sprintf("%s (commit %s)", Version, CommitHash)
+	} else {
+		return fmt.Sprintf("devel (commit %s)", CommitHash)
+	}
+}