Ubiquity.NET.Versioning 6.0.1

About

The Ubiquity.NET.Versioning library provides types to support use of versioning via

1. Semantic Versioning
2. Constrained Semantic Versioning
   • Including Continuous Integration (CI) via CSemVer-CI

It is viable as a standalone package to allow validation of or comparisons to versions reported at runtime. (Especially from native interop that does not support package dependencies or versioning at runtime.)

Example

var quad = new FileVersionQuad(SomeAPiThatRetrievesAFileVersionAsUInt64());
// ...
// NOTE: Since all that is available is a QUAD, which has only 1 bit for CI information,
// there is no way to translate that to a formal CSemVer-CI. Just test ordering of the
// quad.
if(quad > MinimumVer.FileVersion)
{
    // Good to go!
    if( quad.IsCiBuild )
    {
        // and it's a CI build!
    }
}

// ...
static readonly CSemVer MinimumVer = new(1,2,3/*, ...*/);

Formatting

The library contains support for proper formatting of strings based on the rules of a SemVer, CSemVer, and CSemVer-CI. The formatting is done case preserving when possible (Some cases of CSemVer will use string substitution such that PreRelease would simply become pre).

Parsing

The library contains support for parsing of strings based on the rules of a SemVer, CSemVer, and CSemVer-CI

Ordering

The types all support IComparable<T>¹ and properly handle correct sort ordering of the versions according to the rules of SemVer (Which, CSemVer and CSemVer-CI follow with the exception of explicit case insensitivity for AphaNumeric IDs)

^{<a id="footnote_1">1</a>}Unfortunately, major repositories using SemVer have chosen to use different comparisons. Thus, a consumer is required to know a-priori if the version is compared insensitive or not. Thus all constructors accept an enum indicating the sort ordering to use. Additional, parsing accepts an IFormatProvider, which should provide an AlphaNumeircOrdering value to specify the ordering. If none is provided, the default is used. (SemVer uses CaseSensitive comparisons, CSemVer and CSemVerCI ALWAYS use case insensitive) IComparer<SemVer> instances are available for cases where the versions are from mixed sources and the application wishes to order the versions.