Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/levin-riegner/app_versioning
Flutter version tracking and app updates.
https://github.com/levin-riegner/app_versioning
flutter in-app-updates version-manager version-updater versioning
Last synced: 3 months ago
JSON representation
Flutter version tracking and app updates.
- Host: GitHub
- URL: https://github.com/levin-riegner/app_versioning
- Owner: levin-riegner
- License: mit
- Created: 2020-09-07T14:17:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-05T12:53:11.000Z (8 months ago)
- Last Synced: 2024-10-27T09:04:11.818Z (4 months ago)
- Topics: flutter, in-app-updates, version-manager, version-updater, versioning
- Language: Dart
- Homepage: https://pub.dev/packages/app_versioning
- Size: 407 KB
- Stars: 4
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# App Versioning
Keep track of app versions and prompt users to update the app whenever there are new updates available.
## Overview
This packages provides a simple yet customisable way to suggest or force updates to Android & iOS apps.
Built on top of the [in_app_update](https://pub.dev/packages/in_app_update) package for Android and [upgrader](https://pub.dev/packages/upgrader) for iOS.
The package also leverages the [version_tracker](https://pub.dev/packages/version_tracker) plugin to track the app versions accross updates.
## Features
- Retrieve information about available updates from the Play Store or App Store.
- Version bomb. Force users to update the app if the update is mandatory by configuring a minimum version using your custom Backend or [Firebase Remote Config](https://firebase.google.com/docs/remote-config).
- Launch Android updates using the native [In-App Updates](https://developer.android.com/guide/playcore/in-app-updates) flows, supporting flexible and immediate updates.
- Request iOS updates by redirecting the user to the App Store.
- Track version update history and launches to trigger onboarding flows, database migrations, and more.
## Get Started
View the [example project](/example/lib/) for a complete working example.
### Installation
Add the following dependency to your `pubspec.yaml` file:
```yaml
dependencies:
app_versioning: latest
```
### Initializing
1. Initialize the `AppVersioning` class with your app's identifiers and minimum version provider. You can use one of the following factories or create your own implementation of the [AppVersioning](/lib/app_versioning.dart) interface:
- Use the `apiService` factory to retrieve the versioning from your backend.
```dart
final appVersioning = AppVersioning.apiService(
apiConfig: ApiConfig(
endpoints: ApiVersioningEndpoints(
"https://api.example.org",
minimumVersioningEndpoint: "api/api-compatibility",
),
),
updateConfig: UpdateConfig(
appStoreAppId: "1234567890",
playStoreAppId: "org.example.versioning",
appstoreCountryCode: "US",
),
);
```
- Use the `firebaseService` factory to retrieve the versioning from Firebase Remote Config.
```dart
final appVersioning = AppVersioning.firebaseService(
remoteConfigKeys: const RemoteConfigKeys(
minimumIosVersionKey: "minimumIosVersion",
minimumAndroidVersionKey: "minimumAndroidVersion",
),
updateConfig: const UpdateConfig(
appStoreAppId: "1234567890",
playStoreAppId: "org.example.versioning",
appstoreCountryCode: 'US',
),
);
```
2. Track the current version when the app is launched.
```dart
await appVersioning.tracker.track();
```
3. Check whether a new update is available.
```dart
final appUpdateInfo = await appVersioning.getAppUpdateInfo();
```
4. If an update is available, prompt the user to update the app using your own UI elements.
```dart
if (appUpdateInfo.isUpdateAvailable) {
switch (appUpdateInfo.updateType) {
case AppUpdateType.Optional:
_showUpdatePopup(forceUpdate: false);
break;
case AppUpdateType.Mandatory:
_showUpdatePopup(forceUpdate: true);
break;
}
}
```
5. If the user accepts the update, or the update is mandatory, launch the update flow.
```dart
appVersioning.launchUpdate(updateInBackground: true);
```
### Backend Services
Apps using a version below the minimum version will be forced to update with a mandatory update type.
This plugin currently supports 2 different backends to set the minimum version supported on the app.
1. **API**: An arbitrary URL endpoint that returns the minimum versions JSON.
2. **Firebase Remote Config**: Key/value pairs with the minimum versions specified on Firebase.
> This requires the project to include and set up Firebase separately. You can import the configuration using the [remote_config.json](/doc/remote_config/remote_config.json) file.
## Contributing
Check the [CONTRIBUTING.md](CONTRIBUTING.md) guide for more information.
## Deployment
1. Set the new version on the [pubspec.yaml](pubspec.yaml) `version` field.
2. Update the [CHANGELOG.md](CHANGELOG.md) file documenting the changes.
3. Update the [README.md](README.md) file if necessary.
4. Run `dart pub publish --dry-run` to ensure the package can be published successfully.
5. Create a new tag with the release version `git tag -a x.y.z -m "x.y.z" && git push --tags`.
6. Navigate to [GitHub Releases](https://github.com/levin-riegner/app_versioning/releases) and create a new release for the previously created tag, including the [CHANGELOG.md](CHANGELOG.md) changes.
7. Finally run `dart pub publish` to deploy the project.
## Credits
- [upgrader](https://pub.dev/packages/upgrader) - Copyright (c) 2018-2022, Larry Aasen [MIT License](https://pub.dev/packages/upgrader/license) for providing the iOS update mechanisms.
- [in_app_update](https://pub.dev/packages/in_app_update) - Copyright (c) 2020 Victor Choueiri [MIT License](https://pub.dev/packages/in_app_update/license) for providing the Android update mechanisms.
- [version_tracker](https://pub.dev/packages/version_tracker) - Copyright (c) 2021 Kevin Morelli [MIT License](https://pub.dev/packages/version_tracker/license) for providing the code to track version accross updates.
## License
This repo is covered under the [MIT License](LICENSE).