Categorygithub.com/caarlos0/go-version
modulepackage
0.1.1
Repository: https://github.com/caarlos0/go-version.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
7
Dependents
28
Files
161 SLOC

# README

go-version

This package is extracted from sigs.k8s.io/release-utils.

There were a couple of subtle changes made, so it has 0 dependencies and can be used with anything.

Credits goes to the Kubernetes Authors.

Changes

Full list of changes from the original library:

  • drop all dependencies:
    • use std testing only
    • allow to pass a previously generated ASCII art instead of generating it at runtime
  • optional overrides:
    • caller can pass one or more functions that change the version info, so callers are free to use whatever methods they want to provide some options
    • a range of functions are provided by the library
  • added more fields:
    • URL
    • BuiltBy
  • testing
    • added more tests, hopefully preventing breaking changes in the future

# Functions

GetVersionInfo represents known information on how this binary was built.
WithAppDetails allows to set the app name and description.
WithASCIIName allows you to add an ASCII art of the name.
WithBuiltBy allows to set the builder name/builder system name.

# Structs

Info provides the version info.

# Type aliases

Option can be used to customize the version after its gathered from the environment.