Documentation ¶
Index ¶
- Constants
- Variables
- func BuildVersionString() string
- func CompareVersion(version interface{}) int
- func GetDependencyList() []string
- func GetExecEnviron(workDir string, cfg config.Provider, fs afero.Fs) []string
- func GoMinorVersion() int
- func IsRunningAsTest() bool
- type Dependency
- type Info
- type Version
- type VersionString
Constants ¶
const ( EnvironmentDevelopment = "development" EnvironmentProduction = "production" )
Variables ¶
var CurrentVersion = Version{
Number: 0.93,
PatchLevel: 3,
Suffix: "",
}
CurrentVersion represents the current build version. This should be the only one.
var IsExtended = false
Functions ¶
func BuildVersionString ¶
func BuildVersionString() string
BuildVersionString creates a version string. This is what you see when running "hugo version".
func CompareVersion ¶
func CompareVersion(version interface{}) int
CompareVersion compares the given version string or number against the running Hugo version. It returns -1 if the given version is less than, 0 if equal and 1 if greater than the running version.
func GetDependencyList ¶ added in v0.83.0
func GetDependencyList() []string
GetDependencyList returns a sorted dependency list on the format package="version". It includes both Go dependencies and (a manually maintained) list of C(++) dependencies.
func GetExecEnviron ¶ added in v0.70.0
GetExecEnviron creates and gets the common os/exec environment used in the external programs we interact with via os/exec, e.g. postcss.
func GoMinorVersion ¶ added in v0.56.0
func GoMinorVersion() int
func IsRunningAsTest ¶ added in v0.84.0
func IsRunningAsTest() bool
IsRunningAsTest reports whether we are running as a test.
Types ¶
type Dependency ¶ added in v0.92.0
type Dependency struct { // Returns the path to this module. // This will either be the module path, e.g. "github.com/gohugoio/myshortcodes", // or the path below your /theme folder, e.g. "mytheme". Path string // The module version. Version string // Whether this dependency is vendored. Vendor bool // Time version was created. Time time.Time // In the dependency tree, this is the first module that defines this module // as a dependency. Owner *Dependency // Replaced by this dependency. Replace *Dependency }
Dependency is a single dependency, which can be either a Hugo Module or a local theme.
type Info ¶
type Info struct { CommitHash string BuildDate string // The build environment. // Defaults are "production" (hugo) and "development" (hugo server). // This can also be set by the user. // It can be any string, but it will be all lower case. Environment string // contains filtered or unexported fields }
Info contains information about the current Hugo environment
func NewInfo ¶
func NewInfo(environment string, deps []*Dependency) Info
NewInfo creates a new Hugo Info object.
func (Info) Deps ¶ added in v0.92.0
func (i Info) Deps() []*Dependency
Deps gets a list of dependencies for this Hugo build.
func (Info) IsExtended ¶ added in v0.83.0
func (Info) IsProduction ¶ added in v0.66.0
func (Info) Version ¶
func (i Info) Version() VersionString
Version returns the current version as a comparable version string.
type Version ¶
type Version struct { // Major and minor version. Number float32 // Increment this for bug releases PatchLevel int // HugoVersionSuffix is the suffix used in the Hugo version string. // It will be blank for release versions. Suffix string }
Version represents the Hugo build version.
func MustParseVersion ¶
MustParseVersion parses a version string and panics if any error occurs.
func ParseVersion ¶
ParseVersion parses a version string.
func (Version) NextPatchLevel ¶
NextPatchLevel returns the next patch/bugfix Hugo version. This will be a patch increment on the previous Hugo version.
func (Version) ReleaseVersion ¶
ReleaseVersion represents the release version.
type VersionString ¶
type VersionString string
VersionString represents a Hugo version string.
func (VersionString) Compare ¶
func (h VersionString) Compare(other interface{}) int
Compare implements the compare.Comparer interface.
func (VersionString) Eq ¶
func (h VersionString) Eq(other interface{}) bool
Eq implements the compare.Eqer interface.
func (VersionString) String ¶
func (h VersionString) String() string