Documentation
¶
Index ¶
Constants ¶
View Source
const (
BaseVersionControlURL string = "https://github.com/janpfeifer/gonb"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type VersionInfo ¶
func AppVersion ¶
func AppVersion(version, gitVersion, gitHash string) *VersionInfo
AppVersion determines version and commit information based on multiple data sources:
- AppVersion information dynamically added by `git archive` in the remaining to parameters.
- A hardcoded version number passed as first parameter.
- Commit information added to the binary by `go build`.
It's supposed to be called like this in combination with setting the `export-subst` attribute for the corresponding file in .gitattributes:
var AppVersion = version.AppVersion("1.0.0-rc1", "$Format:%(describe)$", "$Format:%H$")
When exported using `git archive`, the placeholders are replaced in the file and this version information is preferred. Otherwise the hardcoded version is used and augmented with commit information from the build metadata.
func (*VersionInfo) Markdown ¶
func (v *VersionInfo) Markdown() string
func (*VersionInfo) Print ¶
func (v *VersionInfo) Print()
Print writes verbose version output to stdout.
Click to show internal directories.
Click to hide internal directories.