Package selection guidance compiled from public package information, community data, and project usage.
release_updater is a Flutter/Dart package that simplifies the process of automatically updating release or installation files within a local directory. It enables developers to manage versioned assets, such as app binaries or configuration files, by fetching and replacing them from a remote source. Ideal for apps requiring frequent updates without full reinstallation, it supports multiple platforms including Android, iOS, macOS, Windows, and Linux. The package streamlines deployment workflows by reducing manual file management and ensuring consistency across environments.
Use cases
Automating app asset updates
Managing versioned installation files
Synchronizing local builds with remote releases
Streamlining CI/CD pipelines
Updating configuration files post-deployment
Key features
Automatic file replacement
Remote source integration
Cross-platform support
Simple CLI command
Version-aware updates
Suitable for
Developers managing frequent app updates
Teams using automated deployment workflows
Projects with distributed build artifacts
CI/CD pipeline integrations
Apps requiring local file synchronization
Considerations
Requires network access for updates
Manual setup for remote source configuration
Limited to local directory updates
Not intended for runtime app updates
Depends on external file availability
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
release_updater
This package brings a simple way to automatically update release/installation files in a local directory.
It also comes with built-in CLI tools to easily generate a release bundle (Zip file) or
serve release files for multiple platforms.
Motivation
Since Dart can run in many native platforms (Linux/x64, macOS/x64/arm64, Windows/x86),
it's not simple to manage all the different releases+platforms files that a
compiled Dart application can have.
In the same way that modern Browsers, and many other applications,
can have automatic builds and updates for multiple platforms, this package
provides tools and an API to easily achieve that.
API Documentation
See the API Documentation for a full list of functions, classes and extension.
Usage
import'dart:io';
import'package:release_updater/release_updater_io.dart';
voidmain() async {
var storage = ReleaseStorageDirectory('appx', Directory('/install/path'));
var provider = ReleaseProviderHttp.baseURL('https://your.domain/appx/releases');
var releaseUpdater = ReleaseUpdater(storage, provider);
var version = await releaseUpdater.update();
print('» Updated to version: $version');
var runResult = await releaseUpdater.runReleaseProcess('run.exe', ['-a']);
var exitCode = runResult!.exitCode;
print('» Exit code: $exitCode');
print('» Result: ${runResult.stdout}');
exit(exitCode);
}
ReleaseProvider
You can implement your own ReleaseProvider or use just the built-in ReleaseProviderHttp class.
CLI Tools
release_updater: A CLI updater.
release_updater_server: A simple HTTP server to provide releases using the shelf package.
version_from: the JSON or YAML file to provide the field version (if the parameter field is not provided).
platform: is a RegExp string to match the building platform. See the ReleasePlatform class.
Command types:
dart_pub_get: performs a dart pub get.
dart_compile_exe: performs a dart compile exe %dart_script.
dart: performs a dart %command.
windows_gui: Changes an executable Windows Subsistem to GUI.
command: performs a shell %command.
rm: Deletes a file.
upload_release: uploads the generated release.
url: release server base URL.
authorization: HTTP basic authorization.
username: authentication username.
password: authentication password.
Command errors:
A command that fails aborts the build: the error is logged, the
remaining commands are NOT executed, and the release_packer CLI
exits with code 1. This avoids a silent error generating and
releasing an incomplete package/artifact.
Some commands are just ignored (skipped) when not applicable, and do
NOT abort the build:
rm of a file that doesn't exist.
windows_gui over a file that is not a Windows executable (the usual
case when building on another platform).
files: each entry of files can be:
A String with a file path:
"file/path.txt"
A Map with extra parameters:
A file with a renamed path and a specific platform.