C# Класс SimpleGitVersion.CIReleaseInfo

Encapsulates CI release information.
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
BaseTag ReleaseTagVersion
BuildVersion string
BuildVersionNuGet string
Depth int

Открытые методы

Метод Описание
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).

Приватные методы

Метод Описание
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

Описание методов

CreateNuGetZeroTimed() публичный статический Метод

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.
Результат string

CreateSemVerZeroTimed() публичный статический Метод

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.
Результат string

Описание свойств

BaseTag публичное свойство

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
Результат ReleaseTagVersion

BuildVersion публичное свойство

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
Результат string

BuildVersionNuGet публичное свойство

Same as BuildVersion instead that the format is based on ReleaseTagFormat.NuGetPackage
public string BuildVersionNuGet
Результат string

Depth публичное свойство

The greatest number of commits between the current commit and the deepest occurence of BaseTag.
public int Depth
Результат int