Onova.ReleaseNotes 1.0.0

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Core 3.0 This package targets .NET Core 3.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.6.1 This package targets .NET Framework 4.6.1. The package is compatible with this framework or higher. 
dotnet add package Onova.ReleaseNotes --version 1.0.0                

                    
                

            
NuGet\Install-Package Onova.ReleaseNotes -Version 1.0.0
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="Onova.ReleaseNotes" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Onova.ReleaseNotes --version 1.0.0                

                    
                

            
#r "nuget: Onova.ReleaseNotes, 1.0.0"
#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 Onova.ReleaseNotes as a Cake Addin
#addin nuget:?package=Onova.ReleaseNotes&version=1.0.0

// Install Onova.ReleaseNotes as a Cake Tool
#tool nuget:?package=Onova.ReleaseNotes&version=1.0.0

Onova.ReleaseNotes

Onova extension that provides support for release notes.

Documentation

This package provides an extension to the UpdateManager. The extension will work only if you use WebPackageResolver. After publishing your application with the manifest, create a text file that has the same name as the version package, except change the file extension to .rn. Example:

    MANIFEST
    DummyApp-1.2.3.zip
    DummyApp-1.2.3.rn
    websetup.exe

Write your desired changes into the release notes file, save and close. In your application, use the following code:

using (var mgr = new UpdateManager(new WebPackageResolver("https://dummy.com/files/MANIFEST"), new ZipPackageExtractor()))
{
  var result = await mgr.CheckForUpdatesAsync();
  var releaseNotes = await mgr.GetReleaseNotes(result.LastVersion);
  ...
}

You can download any version that is available in the manifest.

If you are using my other package, Onova.Publisher, it will make sure to create an empty .rn file for you.

Contributions

I am open to suggestions, PRs, bug reports. Any contribution is welcome.

Licensing

My provided code is licensed under the MIT license.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 is compatible.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETCoreApp 3.0

  • .NETCoreApp 3.1

  • .NETFramework 4.6.1

  • .NETStandard 2.0

  • net5.0

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 375 7/22/2021