AadiSoft.Updater 1.0.3

dotnet add package AadiSoft.Updater --version 1.0.3
                    
NuGet\Install-Package AadiSoft.Updater -Version 1.0.3
                    
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="AadiSoft.Updater" Version="1.0.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AadiSoft.Updater" Version="1.0.3" />
                    
Directory.Packages.props
<PackageReference Include="AadiSoft.Updater" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add AadiSoft.Updater --version 1.0.3
                    
#r "nuget: AadiSoft.Updater, 1.0.3"
                    
#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.
#:package AadiSoft.Updater@1.0.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=AadiSoft.Updater&version=1.0.3
                    
Install as a Cake Addin
#tool nuget:?package=AadiSoft.Updater&version=1.0.3
                    
Install as a Cake Tool

AadiSoft Updater

AadiSoftUpdater is an automatic updater for Windows applications. It checks for updates on a specified GitHub repository and updates the application by downloading and installing the latest MSI file from the repository's releases.

Features

  • Check for updates on a GitHub repository.
  • Download and install the latest MSI file from the repository's releases.
  • Automatically uninstall the old version using the Product Code and install the new version.

Requirements

  • .NET 8
  • C# 12.0

Installation

To use AadiSoftUpdater, include the AadiSoftUpdater.cs file in your project.

Usage

In Windows Forms or WPF applications, you can use the CheckForUpdates method in the Form_Load event to check for updates when the application starts.

Check for Updates

To check for updates, use the CheckForUpdates method. This method checks the README file in the specified GitHub repository for a line containing "Latest Version = x.x.x.x".

using AadiSoftUpdater;

bool isUpdateAvailable = await AadiSoftUpdater.CheckForUpdates("github_username", "repository_name", "Assembly.GetExecutingAssembly().GetName().Version.ToString()");

if (isUpdateAvailable)
{
	// Update is available
}
else
{
	// No update available
}

Update the Application

To update the application, use the UpdateApp method. This method downloads the latest MSI file from the specified GitHub repository's releases and installs it.

await AadiSoftUpdater.UpdateApp("github_username", "repository_name", "MSI_File_Name", "Product_Code_of_App");

Example

Here is an example of how to use AadiSoftUpdater in your application:

using System;
using System.Reflection;
using System.Threading.Tasks;
using AadiSoftUpdater;

class Program
{
	static async Task Main(string[] args)
	{
		string githubRepoOwner = "yourGithubUsername";
		string githubRepoName = "yourRepoName";
		string currentVersion = Assembly.GetExecutingAssembly().GetName().Version.ToString();
		string setupMSIName = "yourSetupMSIName";
		string productCode = "yourProductCode";

		bool isUpdateAvailable = await AadiSoftUpdater.CheckForUpdates(githubRepoOwner, githubRepoName, currentVersion);

		if (isUpdateAvailable)
		{
			if (MessageBox.Show("New Version Available. Do you want to update?", "Update Available", MessageBoxButtons.YesNo) == DialogResult.Yes)
			{
				await AadiSoftUpdater.UpdateApp(githubRepoOwner, githubRepoName, setupMSIName, productCode);
			}
		}
		else
		{
			MessageBox.Show("Application is Up To Date");
		}
	}
}

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

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.3 199 12/23/2024
1.0.2 159 12/23/2024
1.0.1 152 12/23/2024
1.0.0 164 12/23/2024

First Release Automatic Updater Included