BuildInformation

Description

[ShutdownSurvive]
abstract class Tinman.Core.BuildInformation

Derived from

IEquatable<BuildInformation>
IComparable<BuildInformation>

Base interface for classes that represent build information.

Public / Methods

To​String

2 overloads

public method ToString1 → (3)

includeModuleName in : bool

Include ModuleName?

includeVersion opt : bool = true

Include VersionMajor and VersionMinor?

includeBuildDate opt : bool = true

Include BuildDate?

returns → string

human-readable string representation.

Returns a human-readable string representation of this build information.

Public / Attributes

Build​Date

public abstract attribute BuildDate → (get)

value : string

[not-null]
The build date string.

The date of the build.

The BuildDate string stores the build date in the following format: YYYY/MM/DD.

Module​Name

public abstract attribute ModuleName → (get)

value : string

[not-null]
The build module name string.

Human-readable name of the code module this build information is referring to.

The module name is equal to the namespace name that contains the build information class.

Version

public attribute Version → (get)

value : string

[not-null]
The version number string.

The version number of the build in the form: major.minor.

Version​Major

public abstract attribute VersionMajor → (get)

value : int32

[>=1]
The major version number.

The major version number of the build.

Each time the major version number is increased, the minor version number is reset to 0. Breaking changes and thus code migration can become necessary between major versions.

Version​Minor

public abstract attribute VersionMinor → (get)

value : int32

[>=0]
The bugfix number of the build version.

The minor version number of the build.

The minor version number is incremented after bugfixes and patches which do not affect API compatibility, thus breaking changes will not occur and code migration is not necessary.