Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 4.27 KB

README.md

File metadata and controls

77 lines (53 loc) · 4.27 KB
Raw

Utilities

Overview

Build Status Conventional Commits Renovate

Package NuGet.org MyGet
Grynwald.Utilities NuGet MyGet
Grynwald.Utilities.Configuration NuGet MyGet
Grynwald.Utilities.Logging NuGet MyGet
  • Grynwald.Utilities is a collection of utility functions for usage in C#/.NET projects.
  • Grynwald.Utilities.Configuration provides some utilties for working with coniguration, based on IConfiguration
  • Grynwald.Utilities.Logging provides a simple console logger implementation of ILogger

Installation

The libraries are distributed as NuGet package.

  • Prerelease builds are available on MyGet
  • Release versions are available on NuGet.org

API Reference

For documentation of the types in this libary, have a look at the API docs:

Building from source

Utilities is a .NET Standard library.# Building it from source requires the .NET 6 SDK (version 6.0.101 as specified in global.json) and uses Cake for the build.

To execute the default task, run

.\build.ps1

This will build the project, run all tests and pack the NuGet package.

Acknowledgments

Grynwald.Utilities was made possible through a number of libraries (aside from .NET Core and .NET Standard). Thanks to all the people contribution to these projects:

Versioning and Branching

The version of this project is automatically derived from git and the information in version.json using Nerdbank.GitVersioning:

  • The master branch always contains the latest version. Packages produced from master are always marked as pre-release versions (using the -pre suffix).
  • Stable versions are built from release branches. Build from release branches will have no -pre suffix
  • Builds from any other branch will have both the -pre prerelease tag and the git commit hash included in the version string

To create a new release branch use the nbgv tool:

dotnet tool restore
dotnet tool run nbgv -- prepare-release