Tony
3ac748ff28
ci / ✅ Semantic Pull Request (push) Has been cancelled
ci / 🔤 Check Spelling (push) Has been cancelled
ci / 👀 Detect Changes (push) Has been cancelled
Shorebird CI / changes (push) Has been cancelled
Shorebird CI / CSpell (push) Has been cancelled
ci / 🦀 Build ${{ matrix.crate }} (${{ matrix.os }}) (push) Has been cancelled
ci / 🎯 Build ${{ matrix.package }} (push) Has been cancelled
ci / ci (push) Has been cancelled
Shorebird CI / shorebird_code_push (push) Has been cancelled
Shorebird CI / shorebird_code_push_example (push) Has been cancelled
Shorebird CI / required (push) Has been cancelled
- Introduced `setDeviceIdOverride` method in `ShorebirdUpdater` to allow clients to set a custom device ID for patch checks. - Implemented the method in `ShorebirdUpdaterImpl` for both IO and web platforms. - Updated the `Updater` class to handle the device ID override in native bindings. - Added tests for the new functionality in both IO and web test suites, ensuring proper behavior when the updater is available and unavailable.
150 lines
4.8 KiB
Markdown
150 lines
4.8 KiB
Markdown
|
|
<div align=center>
|
|
<img src= "https://raw.githubusercontent.com/shorebirdtech/brand/904722544742c13348f1854a5cc45f4ed223cd17/logo-wordmark/logo_wordmark.png" alt="Shorebird logo">
|
|
<h1>Code Push </h1>
|
|
|
|
[](https://discord.gg/shorebird)
|
|
|
|
[](https://github.com/shorebirdtech/updater/actions/workflows/main.yaml)
|
|
[](https://codecov.io/gh/shorebirdtech/updater)
|
|
[![License: MIT][license_badge]][license_link]
|
|
|
|
<p align=center> Instantly push updates to your Flutter app without lengthy app store review cycles. </p>
|
|
|
|
[Website](https://shorebird.dev?utm_source=pubdev) • [Docs](https://docs.shorebird.dev?utm_source=pubdev) • [X](https://x.com/shorebirddev)• [YouTube](https://www.youtube.com/@shorebird)
|
|
</div>
|
|
|
|
This Dart package communicates with the [Shorebird](https://shorebird.dev) 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](https://docs.shorebird.dev/code-push/?utm_source=pubdev) to learn more
|
|
|
|
## Getting Started
|
|
|
|
If your Flutter app does not already use Shorebird, follow our
|
|
[Getting Started Guide]([https://docs.shorebird.dev/getting-started/?utm_source=pubdev]) to add code push to your
|
|
app.
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
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.
|
|
|
|
```dart
|
|
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](https://docs.shorebird.dev/code-push/guides/percentage-based-rollouts/) 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:
|
|
|
|
```sh
|
|
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):
|
|
|
|
```dart
|
|
updater.checkForUpdate(track: UpdateTrack.beta);
|
|
```
|
|
|
|
You can also use custom track names. When creating a patch, specify a track name
|
|
like this:
|
|
|
|
```sh
|
|
shorebird patch android --track my-custom-track
|
|
```
|
|
|
|
And:
|
|
|
|
```dart
|
|
updater.checkForUpdate(track: UpdateTrack('my-custom-track'));
|
|
```
|
|
|
|
**Note:** Updating to a specific track does not uninstall patches from other
|
|
tracks. See [#3484](https://github.com/shorebirdtech/shorebird/issues/3484)
|
|
for details.
|
|
|
|
### Device id override
|
|
|
|
The updater generates a random per-install `client_id` on first startup and
|
|
persists it locally. Self-hosted update servers that encrypt or target patches
|
|
per app/account device can override that id before checking for updates:
|
|
|
|
```dart
|
|
final updater = ShorebirdUpdater();
|
|
await updater.setDeviceIdOverride('stable-app-device-id');
|
|
await updater.checkForUpdate();
|
|
```
|
|
|
|
Do not put secrets in this value. It is sent to the update server as
|
|
`client_id`; encryption keys should be derived from server-side or
|
|
app-provided key material.
|
|
|
|
## Join us on Discord!
|
|
|
|
We have an active [Discord server](https://discord.gg/shorebird) where you can
|
|
ask questions and get help.
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
|
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
|
|
[license_link]: https://opensource.org/licenses/MIT
|