versionutil

Documentation

Overview

Holds the CLI related version functions that unifies handling version printing in all CLIs binaries.

Extends the https://github.com/prometheus/common/blob/main/version/info.go package by adding common CLI support and test coverage.

Index

• func Print(out io.Writer, program string)
• func RegisterFlags(fs *flag.FlagSet)
• func RegisterIntoKingpinFlags(app *kingpin.Application)
• func RegisterParseFlags()
• func ShouldPrintVersion() bool

Functions

func Print

func Print(out io.Writer, program string)

Print version information to a given out writer.

func RegisterFlags

func RegisterFlags(fs *flag.FlagSet)

RegisterFlags registers version related flags to core.

func RegisterIntoKingpinFlags

func RegisterIntoKingpinFlags(app *kingpin.Application)

RegisterIntoKingpinFlags registers version related flags in kingpin framework.

func RegisterParseFlags

func RegisterParseFlags()

RegisterParseFlags registers and parses version related flags.

func ShouldPrintVersion

func ShouldPrintVersion() bool

ShouldPrintVersion returns true if version should be printed. Use Print function to print version information.