C# Class SimpleGitVersion.CIReleaseInfo

Encapsulates CI release information.
Datei anzeigen Open project: SimpleGitVersion/SGV-Net Class Usage Examples

Public Properties

Property Type Description
BaseTag ReleaseTagVersion
BuildVersion string
BuildVersionNuGet string
Depth int

Public Methods

Method Description
CreateNuGetZeroTimed ( string ciBuildName, System.DateTime timeRelease ) : string

Creates the ZeroTimed NuGetV2 version string.
CreateSemVerZeroTimed ( string ciBuildName, System.DateTime timeRelease, string actualBaseTag = null ) : string

Creates the ZeroTimed SemVer version string. The actualBaseTag, if not null, is appended as a suffix (Build metadata).

Private Methods

Method Description
CIReleaseInfo ( ReleaseTagVersion ciBaseTag, int ciBaseDepth, string ciBuildVersion, string ciBuildVersionNuGet ) : System
Create ( Commit commit, CIBranchVersionMode ciVersionMode, string ciBuildName, StringBuilder errors, CommitVersionInfo info ) : CIReleaseInfo
ToBase62 ( long number ) : string

Method Details

CreateNuGetZeroTimed() public static method

Creates the ZeroTimed NuGetV2 version string.
public static CreateNuGetZeroTimed ( string ciBuildName, System.DateTime timeRelease ) : string
ciBuildName string The BuildName string (typically "develop").
timeRelease System.DateTime The utc date time of the release.
return string

CreateSemVerZeroTimed() public static method

Creates the ZeroTimed SemVer version string. The actualBaseTag, if not null, is appended as a suffix (Build metadata).
public static CreateSemVerZeroTimed ( string ciBuildName, System.DateTime timeRelease, string actualBaseTag = null ) : string
ciBuildName string The BuildName string (typically "develop").
timeRelease System.DateTime The utc date time of the release.
actualBaseTag string An optional base release that will be added as build metadata.
return string

Property Details

BaseTag public_oe property

The base ReleaseTagVersion from which BuildVersion is built. It is either the the previous release or the ReleaseTagVersion.VeryFirstVersion. Null if and only if CIBuildVersion is null.
public ReleaseTagVersion,SimpleGitVersion BaseTag
return ReleaseTagVersion

BuildVersion public_oe property

Not null only if we are on a branch that is enabled in RepositoryInfoOptions.Branches (either because it is the current branch or RepositoryInfoOptions.StartingBranchName specifies it), the RepositoryInfoOptions.StartingCommitSha is null or empty and there is no RepositoryInfo.ValidReleaseTag on the commit. The format is based on ReleaseTagFormat.SemVer
public string BuildVersion
return string

BuildVersionNuGet public_oe property

Same as BuildVersion instead that the format is based on ReleaseTagFormat.NuGetPackage
public string BuildVersionNuGet
return string

Depth public_oe property

The greatest number of commits between the current commit and the deepest occurence of BaseTag.
public int Depth
return int