package
0.0.0-20241107114533-5702851476d2
Repository: https://github.com/open-ch/kaeter.git
Documentation: pkg.go.dev
# Functions
FindVersionsYamlFilesInPath concurrently looks for versions.yaml files starting from the given path down each folder recursively.
GetKaeterModules searches the repo for all Kaeter modules.
GetVersionsFilePath checks if the passed path is a directory, then: - checks if there is a versions.yml or .yaml file, and appends the existing one to the abspath if so - appends 'versions.yaml' to it if there is none.
Initialize initializes a kaeter modules with the required files based on the config typically the versions.yaml, a readme and a changelog.
NewVersion creates a Major.Minor.Patch VersionNumber.
PrintModuleInfo outputs info about a module at the given relative path in pretty format, if said module exists.
ReadFromFile reads a Versions object from the YAML file living at the passed path.
UnmarshalVersionMetadata builds a VersionMetadata struct from the two strings containing the raw version and release data.
UnmarshalVersionString builds a VersionIdentifier struct from a string (x.y.z).
# Variables
ErrModuleDependencyPath is generated when stats cannot be loaded for the dependency path in a kaeter module.
# Structs
InitializationConfig holds the parameters that can be tweaked when initializing a new kaeter module.
KaeterModule contains information about a single module.
Metadata olds the parsed Annotations from versions.yaml if present.
VersionMetadata contains some basic information assorted to a version number.
VersionNumber compose a semver.Version.
Versions is a fully unmarshalled representation of a versions file.
VersionString a version represented by an arbitrary string.
# Interfaces
VersionIdentifier represents a 'version number' when SemVer/CalVer are in use or an arbitrary string otherwise.
# Type aliases
SemVerBump defines the options for semver bumps, default to patch, and allow major, minor.