Table of Contents

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
    • Including FileVersion QUAD representation
    • Including OrderedVersion integral representation.

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.) The Ubiquity.NET.Versioning.Build.Tasks is a companion project that implements automated build support for CSemVer.

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

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)

Warning

The SemVer spec does not explicitly mention case sensitivity for comparing the pre-release components (AlphaNumeric Identifiers) in a version. It does state that they are compared lexicographically, which would imply they are case sensitive. However, major repository implementations have chosen different approaches to how the strings are compared and thus the ambiguities of reality win out over any specified implicit behavior. Thus, consumers, MUST specify the expected ordering for a SemVer when creating it.

Warning

The formal 'spec' for CSemVer remains mostly silent on the point of the short format. See this known issue. Since, the existence of that form was to support NuGet V2, which is now obsolete, this library does not support the short form at all. (This choice keeps documentation clarity [NOT SUPPORTED] and implementation simplicity)

Edit this page