Version Handling (#458)

* adding version command and version marker

* updates based on feedback

Dockerfile

@@ -11,6 +11,7 @@ WORKDIR /src
 COPY go.mod go.sum ./
 COPY ./cmd ./cmd
 COPY ./pkg ./pkg
+COPY .git .git
 
 RUN --mount=type=cache,id=gomod,target=/go/pkg/mod \
     --mount=type=cache,id=gobuild,target=/root/.cache/go-build \

RELEASE_NOTES.md

@@ -4,6 +4,8 @@
 
 ## General
 
+* Added version command and version marker on CRB images
+
 ## API
 
 ### Image Definition Changes

cmd/eib/main.go

@@ -14,6 +14,7 @@ func main() {
 	app.Commands = []*cli.Command{
 		cmd.NewBuildCommand(build.Run),
 		cmd.NewValidateCommand(build.Validate),
+		cmd.NewVersionCommand(build.Version),
 	}
 
 	if err := app.Run(os.Args); err != nil {

pkg/cli/build/version.go

@@ -0,0 +1,12 @@
+package build
+
+import (
+	"github.com/suse-edge/edge-image-builder/pkg/log"
+	"github.com/suse-edge/edge-image-builder/pkg/version"
+	"github.com/urfave/cli/v2"
+)
+
+func Version(_ *cli.Context) error {
+	log.Auditf("Edge Image Builder Version: %s", version.GetVersion())
+	return nil
+}

pkg/cli/cmd/version.go

@@ -0,0 +1,16 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/urfave/cli/v2"
+)
+
+func NewVersionCommand(action func(*cli.Context) error) *cli.Command {
+	return &cli.Command{
+		Name:      "version",
+		Usage:     "Inspect program version",
+		UsageText: fmt.Sprintf("%s version", appName),
+		Action:    action,
+	}
+}

pkg/combustion/message.go

@@ -9,22 +9,35 @@ import (
 	"github.com/suse-edge/edge-image-builder/pkg/fileio"
 	"github.com/suse-edge/edge-image-builder/pkg/image"
 	"github.com/suse-edge/edge-image-builder/pkg/log"
+	"github.com/suse-edge/edge-image-builder/pkg/template"
+	"github.com/suse-edge/edge-image-builder/pkg/version"
 )
 
 const (
 	messageScriptName    = "48-message.sh"
 	messageComponentName = "identifier"
 )
 
-//go:embed templates/48-message.sh
+//go:embed templates/48-message.sh.tpl
 var messageScript string
 
 func configureMessage(ctx *image.Context) ([]string, error) {
-	filename := filepath.Join(ctx.CombustionDir, messageScriptName)
+	values := struct {
+		Version string
+	}{
+		Version: version.GetVersion(),
+	}
 
-	if err := os.WriteFile(filename, []byte(messageScript), fileio.ExecutablePerms); err != nil {
+	data, err := template.Parse(messageScriptName, messageScript, &values)
+	if err != nil {
+		return nil, fmt.Errorf("parsing message script template: %w", err)
+	}
+
+	filename := filepath.Join(ctx.CombustionDir, messageScriptName)
+	err = os.WriteFile(filename, []byte(data), fileio.ExecutablePerms)
+	if err != nil {
 		log.AuditComponentFailed(messageComponentName)
-		return nil, fmt.Errorf("copying script %s: %w", messageScriptName, err)
+		return nil, fmt.Errorf("writing message script: %w", err)
 	}
 
 	log.AuditComponentSuccessful(messageComponentName)

pkg/combustion/templates/48-message.sh.tpl

@@ -0,0 +1,3 @@
+#!/bin/bash
+set -euo pipefail
+echo "Configured with the Edge Image Builder {{ .Version }}" >> /etc/issue.d/eib

pkg/version/version.go

@@ -0,0 +1,24 @@
+package version
+
+import (
+	"fmt"
+	"runtime/debug"
+)
+
+var version string
+
+func GetVersion() string {
+	if version != "" {
+		return version
+	}
+
+	if info, ok := debug.ReadBuildInfo(); ok {
+		for _, setting := range info.Settings {
+			if setting.Key == "vcs.revision" {
+				return fmt.Sprintf("git-%s", setting.Value)
+			}
+		}
+	}
+
+	return "Unknown"
+}