version

package
v0.7.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

README

Version Package

This package provides version information for the GitHub Metrics Aggregator binary.

Purpose

To store and expose version, commit SHA, and architecture information, typically set during the build process.

Files

  • version.go: Defines variables like Name, Version, Commit, OSArch, and HumanVersion. It attempts to read the VCS revision (commit SHA) from Go's build information if not explicitly set.

Usage

This package is used by the CLI to display version information to the user.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// Name is the name of the binary. This can be overridden by the build
	// process.
	Name = "github-metrics-aggregator"

	// Version is the main package version. This can be overridden by the build
	// process.
	Version = "source"

	// Commit is the git sha. This can be overridden by the build process.
	Commit = func() string {
		if info, ok := debug.ReadBuildInfo(); ok {
			for _, setting := range info.Settings {
				if setting.Key == "vcs.revision" {
					return setting.Value
				}
			}
		}
		return "HEAD"
	}()

	// OSArch is the operating system and architecture combination.
	OSArch = runtime.GOOS + "/" + runtime.GOARCH

	// HumanVersion is the compiled version.
	HumanVersion = Name + " " + Version + " (" + Commit + ", " + OSArch + ")"
)

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL