vaultik/internal/globals/globals.go

// Package globals holds application-wide metadata (name, version,
// commit) that is populated at build time via linker flags.
package globals

import (
	"strings"
	"time"
)

// Appname is the application name, populated from main().
var Appname = "vaultik" //nolint:gochecknoglobals // set via -ldflags at build time

// DevVersion is the version a binary reports when it was not built
// from a tagged commit. script/version emits either this exact string
// (outside a git checkout) or this string followed by "-" and the
// commit it was built from, and goreleaser's snapshot template matches
// that shape. It is deliberately not a number: a build that is not a
// release must not name itself like one.
const DevVersion = "dev"

// Version is the application version, populated from main().
var Version = DevVersion //nolint:gochecknoglobals // set via -ldflags at build time

// Commit is the git commit hash, populated from main().
var Commit = "unknown" //nolint:gochecknoglobals // set via -ldflags at build time

// CommitDate is the ISO-8601 date of the commit, populated from main().
var CommitDate = "unknown" //nolint:gochecknoglobals // set via -ldflags at build time

// Author identifies the upstream author of vaultik.
const Author = "Jeffrey Paul <sneak@sneak.berlin>"

// Homepage is the canonical URL for vaultik.
const Homepage = "https://sneak.berlin/go/vaultik"

// ReleasesURL is where tagged release artifacts are published.
const ReleasesURL = "https://git.eeqj.de/sneak/vaultik/releases"

// License is the SPDX identifier for the project license.
const License = "MIT"

// Globals contains application-wide configuration and metadata.
type Globals struct {
	Appname    string
	Version    string
	Commit     string
	CommitDate string
	StartTime  time.Time
}

// New creates and returns a new Globals instance initialized with the
// package-level variables.
func New() (*Globals, error) {
	return &Globals{
		Appname:    Appname,
		Version:    Version,
		Commit:     Commit,
		CommitDate: CommitDate,
	}, nil
}

// IsDevVersion reports whether v names a development build rather than
// a release. Both "dev" and "dev-<sha>" (and its "-dirty" variant)
// count: a caller that compares against "dev" exactly would treat every
// commit-stamped development build as a release.
func IsDevVersion(v string) bool {
	return v == DevVersion || strings.HasPrefix(v, DevVersion+"-")
}

// shortCommitLen is the number of commit-hash characters ShortCommit keeps.
const shortCommitLen = 12

// ShortCommit returns the first 12 chars of the commit hash, or the
// whole string if it's shorter (e.g. "unknown").
func (g *Globals) ShortCommit() string {
	if len(g.Commit) > shortCommitLen {
		return g.Commit[:shortCommitLen]
	}

	return g.Commit
}