Eric Seidel
6d0e4a1193
* chore(deps): bump Rust and Dart dependencies Bump Rust dependencies in library/ and patch/: - comde: 0.2.3 → 0.3.1 (library), 0.2.3 → 0.3.0 (patch) - zip: 0.6.4 → 3.0.0 (breaking: FileOptions → SimpleFileOptions) - android_logger: 0.13.0 → 0.15.0 - mockall: 0.12.1 → 0.13.1 - serial_test: 2.0.0 → 3.2.0 - cbindgen: 0.24.0 → 0.28.0 Bump Dart dev dependency in shorebird_code_push/: - ffigen: upper bound <17.0.0 → <19.0.0 Updated zip API usage (FileOptions → SimpleFileOptions) and adjusted test assertion for changed error message. Binary size impact (macOS release, arm64): - libupdater.a: +83 KB (+0.28%) - libupdater.dylib: +34 KB (+0.75%) Closes #206, #271, #273. * chore: add EOCD to cspell dictionary The zip 3.0 crate changed its error message to reference "EOCD" (End of Central Directory), which cspell doesn't recognize.
Code Push
Instantly push updates to your Flutter app without lengthy app store review cycles.
This Dart package communicates with the Shorebird Code Push Updater to:
- ✅ Get the currently installed patch version
- ✅ Check whether a new patch is available
- ✅ Download new patches
Demo
Explore this interactive demo to learn more
Getting Started
If your Flutter app does not already use Shorebird, follow our Getting Started Guide to add code push to your app.
Installation
flutter pub add shorebird_code_push
Usage
Shorebird automatically checks for and downloads updates in the background. Most apps do not need this package. This package is for apps that want additional control, such as displaying update status to the user or prompting before downloading.
Important: checkForUpdate() and update() make network calls that may
be slow. Avoid gating app startup on the result (e.g. awaiting in initState),
as the app may appear stuck on the splash screen. Use .then() instead.
import 'package:shorebird_code_push/shorebird_code_push.dart';
void main() => runApp(const MyApp());
// [Other code here]
class _MyHomePageState extends State<MyHomePage> {
final updater = ShorebirdUpdater();
Patch? _currentPatch;
bool _updateAvailable = false;
@override
void initState() {
super.initState();
// Read the current patch number (null if no patch is installed).
updater.readCurrentPatch().then((patch) {
setState(() => _currentPatch = patch);
});
// Check if an update is available to show in the UI.
updater.checkForUpdate().then((status) {
setState(() => _updateAvailable = status == UpdateStatus.outdated);
});
}
// [Other code here]
}
See the example for a complete working app.
Tracks
Shorebird supports publishing patches to different tracks, which can be used to target different segments of your user base. See the percentage based rollout guide for implementation details.
You must first publish a patch to a specific track (patches are published to the
stable track by default). To publish a patch to a different track, update your
patch command to use the --track argument:
shorebird patch android --track beta
(We're just using Android for this example. Tracks are supported on all platforms).
To check for updates on a given track, pass an UpdateTrack to
checkForUpdate (and update if you use it):
updater.checkForUpdate(track: UpdateTrack.beta);
You can also use custom track names. When creating a patch, specify a track name like this:
shorebird patch android --track my-custom-track
And:
updater.checkForUpdate(track: UpdateTrack('my-custom-track'));
Note: Updating to a specific track does not uninstall patches from other tracks. See #3484 for details.
Join us on Discord!
We have an active Discord server where you can ask questions and get help.
Contributing
See CONTRIBUTING.md.