Release-style semantic version, i.e., M.N.P
SDM goal event triggering this action
Clean, branch-aware, pre-release version string
Take a possibly invalid semantic version and make it valid. The
function replaces _, ., and / with -, removes characters
not allowed in a prerelease identifier, and remove adjacent -
characters. If the resulting cleaned identifier starts with a zero
(0) and is all numbers, leading zeroes are removed. If removing
leading zeroes leads to an empty identifier, "ZERO" is returned.
Clean semantic version prerelease identifier string
Iterate through all the tags associated with the after commit
of the push for the provided goal invocation. If any tag is a
milesone or release candidate version, return that version.
Otherwise, return undefined.
Goal invocation
Milestone or release candidate version or undefined
Determine if provided version is a milestone or release candidate version, i.e., a prerelease whose first prerelease identifer is "M" or "RC".
Version to interrogate
true if version is a milestone or release candidate, false otherwise
If there is a milestone or release candidate version tag associated with the after commit for the push triggering the provided goal invocation, return it. Otherwise return the provided version stripped of any prerelease identifier and/or build metadata.
This helps you treat more standard prerelease versions, i.e., milestone and release candidate versions, like real releases.
Prerelease version string
Goal invocation
Release, milestone, or release candidate version
Calculate release version from provided prerelease version, also stripping any build metadata if present.
Semantic version to reduce to release version
Release semantic version
Generated using TypeDoc
Make a release version a branch-aware pre-release version. A timestamp is appended to the version. If the goal event was triggered from a non-default branch, a sanitized version of the branch name is inserted between the release version and the timestamp.