CodeMade.GithubUpdateChecker 0.1.11

.NET 6.0 .NET Framework 4.7.2

dotnet add package CodeMade.GithubUpdateChecker --version 0.1.11

NuGet\Install-Package CodeMade.GithubUpdateChecker -Version 0.1.11

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="CodeMade.GithubUpdateChecker" Version="0.1.11" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add CodeMade.GithubUpdateChecker --version 0.1.11

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: CodeMade.GithubUpdateChecker, 0.1.11"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install CodeMade.GithubUpdateChecker as a Cake Addin
#addin nuget:?package=CodeMade.GithubUpdateChecker&version=0.1.11

// Install CodeMade.GithubUpdateChecker as a Cake Tool
#tool nuget:?package=CodeMade.GithubUpdateChecker&version=0.1.11

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Github Update Checker

This is a .net library and a nuget package that allows you to check for release updates on github repositories, and show a notification to the user.

It's meant to be used by applications that target Windows (at least Windows 10), and are distributed via GitHub Releases.

Usage:

var currentVersion = Assembly.GetExecutingAssembly().GetName().Version;
var checker = VersionChecker.Create("myusername", "myrepo", currentVersion, "My App Name");
Task.Run(() => checker.NotifyIfNewVersion());

Some notes about defaults:

By default, the checker will only notify the user once per day. You can change this by setting the NotificationFrequency property.
By default, the checker will use a temp file to store the last time it notified the user. You can change this by passing a custom class that implements INotificationStorage to the constructor of VersionChecker.
If your version tag has a prefix (e.g. v1.0.0), you should set the optional versionPrefix parameter in VersionChecker.Create() to that prefix (v in this example).

Product	Compatible and additional computed target framework versions.
.NET	net6.0-windows10.0.17763 is compatible. net7.0-windows was computed. net8.0-windows was computed.
.NET Framework	net472 is compatible. net48 was computed. net481 was computed.