Dvelop.Sdk.Logging.Abstractions 0.2.0.111-prerelease

d.velop cloud SDK for .NET

This is the official SDK to build Apps for d.velop cloud using the C# programming language.

The project has alpha status. So for now expect things to change.

Packages

Usage

Include the d.velop sdk packages as dependencies in your .NET 10 project file (myproject.csproj) and restore them with dotnet restore via commandline or from within your IDE.

Example:

<ItemGroup>
    <PackageReference Include="Dvelop.Sdk.TenantMiddleware" Version="0.2.0.*" />
    <PackageReference Include="Dvelop.Sdk.IdentityProvider.Middleware" Version="0.2.0.*" />
</ItemGroup>

or the all-in-one dependency:

<ItemGroup>
    <PackageReference Include="Dvelop.Sdk" Version="0.2.0.*" />
</ItemGroup>

The most recent version can be installed from nuget.org

A running Application, which uses this SDK can be found at github.com/d-velop/dvelop-app-template-cs

Reading the application version with IVersionProvider

IVersionProvider exposes the version of the running application as a SemVer (Major, Minor, Patch, Qualifier). VersionProvider is the default implementation. It reads the AssemblyInformationalVersion of the assembly you pass to it and parses it, e.g. 1.2.3-beta or 1.2.3+build.5. If the version has no qualifier, Qualifier is an empty string.

Because the provider lives in the SDK library, you have to tell it which assembly to read, otherwise it would report the SDK's own version. Register it in your dependency injection container with the assembly of your application:

using Dvelop.Sdk.ApplicationInformation;

builder.Services.AddSingleton<IVersionProvider>(new VersionProvider(typeof(Program).Assembly));

and inject it where you need the version:

app.MapGet("/version", (IVersionProvider versionProvider) =>
{
    SemVer version = versionProvider.Version;
    return Results.Ok(new { version = version.ToString("s"), qualifier = version.Qualifier });
});

SemVer can also be created from a string and compared (the qualifier is ignored when comparing):

var current = SemVer.FromString("1.4.0-beta");
if (current >= SemVer.FromString("1.2.0"))
{
    // feature is available
}

Use ToString("s") for Major.Minor.Patch; the default format additionally appends the qualifier.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

License

Please read LICENSE for licensing information.

Acknowledgments

Thanks to the following projects for inspiration

• Starting an Open Source Project
• README template
• CONTRIBUTING template