Class VersionResult

Models the result object returned from version calculation.

Inheritance
System.Object
VersionResult
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: SimpleVersion
Assembly: SimpleVersion.Abstractions.dll
Syntax
public class VersionResult

Properties

| Improve this Doc View Source

BranchName

Gets or sets the friendly branch name of the current branch.

Declaration
public string BranchName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

CanonicalBranchName

Gets or sets the full canonical name of the current branch.

Declaration
public string CanonicalBranchName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Formats

Gets the collection of generated version strings.

Declaration
public IDictionary<string, string> Formats { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>
| Improve this Doc View Source

Height

Gets or sets the calculated height.

Declaration
public int Height { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

HeightPadded

Gets the height as a 0 padded four digit string.

Declaration
public string HeightPadded { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IsPullRequest

Gets a value indicating whether the current branch is a pull request.

Declaration
public bool IsPullRequest { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsRelease

Gets or sets a value indicating whether the result is from a release configuration.

Declaration
public bool IsRelease { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Major

Gets or sets the generated major version part.

Declaration
public int Major { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Minor

Gets or sets the generated minor version part.

Declaration
public int Minor { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Patch

Gets or sets the generated patch version part.

Declaration
public int Patch { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

PullRequestNumber

Gets the pull request number (if the current branch is a pull request).

Declaration
public int PullRequestNumber { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RepositoryPath

Gets or sets the path to the repository.

Declaration
public string RepositoryPath { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Revision

Gets or sets the generated revision version part.

Declaration
public int Revision { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Sha

Gets or sets the full sha of the current commit.

Declaration
public string Sha { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Sha7

Gets the shortened (7 char) sha of the current commit.

Declaration
public string Sha7 { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Version

Gets or sets the generated version.

Declaration
public string Version { get; set; }
Property Value
Type Description
System.String

Extension Methods