Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update iOS status #175

Merged
merged 3 commits into from
Jan 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 24 additions & 26 deletions docs/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,39 +22,37 @@ every day and we welcome your feedback. Filing
Shorebird is currently in alpha on iOS. Instructions for using Shorebird on
iOS are available in the [Getting Started](/) guide.

It is safe to ship with Shorebird on iOS. Please note there may be performance
(currently slower than Android) and patch size (larger than Android) differences
in the alpha product.

We expect to reach parity with Shorebird on Android around October 2023.

You can see all open issues for iOS [on
GitHub](https://github.com/shorebirdtech/shorebird/issues?q=is%3Aopen+is%3Aissue+label%3Aios)

## Known issues

Commonly requested features on iOS and Android:
We expect to reach parity with Shorebird on Android around Feb 2024. This has
taken longer that we'd hoped, but you can follow our progress on any of the open
issues for iOS [on
GitHub](https://github.com/shorebirdtech/shorebird/issues?q=is%3Aopen+is%3Aissue+label%3Aios),
notably on [iOS speed](https://github.com/shorebirdtech/shorebird/issues/674).

### Why is iOS Alpha?

iOS is alpha for two reasons:

- Our iOS alpha product is slower than our Android product. In testing, many
apps do not notice notice a difference, some feel a bit slower. Our internal
benchmarks suggest we can make the Dart code execute up to 100x faster than it
currently does in ios-alpha and we've built an new Dart runtime to solve this
speed issue, but it's not ready yet. We update our progress on
https://github.com/shorebirdtech/shorebird/issues/674 every week and on
Discord https://discord.gg/shorebird every day.
- We've seen a few few crashes reported from early users when testing this new
runtime. We're working with our early customers to resolve these issues. The
plan is to mark iOS "beta" as soon as we're comfortable with the speed, and
1.0 once we've seen enough deployments to know it's not crashing for anyone.

## Commonly requested features on iOS and Android:

- Self-hosting or on-premises deployments [issue](https://github.com/shorebirdtech/shorebird/issues/485)
- Asset changes (images, icons, etc.) [issue](https://github.com/shorebirdtech/shorebird/issues/318)
- Older Flutter versions (only
[recent stable versions](https://docs.shorebird.dev/flutter-version) are
currently supported)
[issue](https://github.com/shorebirdtech/shorebird/issues/1100)
- Analytics [issue](https://github.com/shorebirdtech/shorebird/issues/197)
- Manual rollbacks (automatic single-device rollbacks on errors already work) ([issue](https://github.com/shorebirdtech/shorebird/issues/126))
- Staged rollout of patches (channels or percentage based) [issue](https://github.com/shorebirdtech/shorebird/issues/110)
- Patch signing (patch hashes are already checked) [issue](https://github.com/shorebirdtech/shorebird/issues/112)
- Fastlane integration [issue](https://github.com/shorebirdtech/shorebird/issues/257)
- Patch signing (hashes are checked for download integrity) [issue](https://github.com/shorebirdtech/shorebird/issues/112)
- "Native code" changes (java, kotlin, etc.) -- not planned.

iOS "alpha" specific issues (which will be resolved before production):

- iOS apps built with `shorebird release ios-alpha` run Dart code [slower than
normal release builds](https://github.com/shorebirdtech/shorebird/issues/674).
- iOS patches are proportional to the size of the app, rather than the size of
the change, and thus larger than patches on Android.
[issue](https://github.com/shorebirdtech/shorebird/issues/675)

If these, or anything else is blocking your use of Shorebird, please let us know!
https://github.com/shorebirdtech/shorebird/issues