Skip to content

Commit 5566960

Browse files
stuartmorgan-gstuartmorgan-g
authoredApr 4, 2022
Add supported OS version tables to READMEs (flutter#5106)
1 parent 3647ba1 commit 5566960

File tree

37 files changed

+609
-47
lines changed

37 files changed

+609
-47
lines changed
 

‎.cirrus.yml

+1
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ task:
101101
always:
102102
format_script: ./script/tool_runner.sh format --fail-on-change
103103
pubspec_script: ./script/tool_runner.sh pubspec-check
104+
readme_script: ./script/tool_runner.sh readme-check
104105
license_script: dart $PLUGIN_TOOL license-check
105106
- name: federated_safety
106107
# This check is only meaningful for PRs, as it validates changes

‎packages/espresso/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 0.2.0
26

37
* Updates compileSdkVersion to 31.

‎packages/espresso/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Provides bindings for Espresso tests of Flutter Android apps.
44

5+
| | Android |
6+
|-------------|---------|
7+
| **Support** | SDK 16+ |
8+
59
## Installation
610

711
Add the `espresso` package as a `dev_dependency` in your app's pubspec.yaml. If you're testing the example app of a package, add it as a dev_dependency of the main package as well.
@@ -99,4 +103,3 @@ gcloud firebase test android run --type instrumentation \
99103
--results-bucket=<RESULTS_BUCKET> \
100104
--results-dir=<RESULTS_DIRECTORY>
101105
```
102-

‎packages/file_selector/file_selector/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 0.8.4+1
26

37
* Adds README information about macOS entitlements.

‎packages/file_selector/file_selector/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
A Flutter plugin that manages files and interactions with file dialogs.
66

7+
| | macOS | Web | Windows |
8+
|-------------|--------|-----|-------------|
9+
| **Support** | 10.11+ | Any | Windows 10+ |
10+
711
## Usage
812
To use this plugin, add `file_selector` as a [dependency in your pubspec.yaml file](https://flutter.dev/platform-plugins/).
913

‎packages/flutter_plugin_android_lifecycle/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 2.0.5
26

37
* Updates compileSdkVersion to 31.

‎packages/flutter_plugin_android_lifecycle/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ The purpose of having this plugin instead of exposing an Android `Lifecycle` obj
99
Android embedding plugins API is to force plugins to have a pub constraint that signifies the
1010
major version of the Android `Lifecycle` API they expect.
1111

12+
| | Android |
13+
|-------------|---------|
14+
| **Support** | SDK 16+ |
15+
1216
## Installation
1317

1418
Add `flutter_plugin_android_lifecycle` as a [dependency in your pubspec.yaml file](https://flutter.dev/using-packages/).
@@ -32,7 +36,7 @@ public class MyPlugin implements FlutterPlugin, ActivityAware {
3236
Lifecycle lifecycle = FlutterLifecycleAdapter.getActivityLifecycle(binding);
3337
// Use lifecycle as desired.
3438
}
35-
39+
3640
//...
3741
}
3842
```

‎packages/google_maps_flutter/google_maps_flutter/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 2.1.3
26

37
* Fixes iOS crash on `EXC_BAD_ACCESS KERN_PROTECTION_FAILURE` if the map frame changes long after creation.

‎packages/google_maps_flutter/google_maps_flutter/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
A Flutter plugin that provides a [Google Maps](https://developers.google.com/maps/) widget.
66

7+
| | Android | iOS |
8+
|-------------|---------|--------|
9+
| **Support** | SDK 20+ | iOS 9+ |
10+
711
## Usage
812

913
To use this plugin, add `google_maps_flutter` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).
@@ -60,7 +64,7 @@ if (defaultTargetPlatform == TargetPlatform.android) {
6064

6165
### iOS
6266

63-
This plugin requires iOS 9.0 or higher. To set up, specify your API key in the application delegate `ios/Runner/AppDelegate.m`:
67+
To set up, specify your API key in the application delegate `ios/Runner/AppDelegate.m`:
6468

6569
```objectivec
6670
#include "AppDelegate.h"

‎packages/google_sign_in/google_sign_in/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 5.2.4
26

37
* Internal code cleanup for stricter analysis options.

‎packages/google_sign_in/google_sign_in/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ _Note_: This plugin is still under development, and some APIs might not be
66
available yet. [Feedback](https://github.com/flutter/flutter/issues) and
77
[Pull Requests](https://github.com/flutter/plugins/pulls) are most welcome!
88

9+
| | Android | iOS | Web |
10+
|-------------|---------|--------|-----|
11+
| **Support** | SDK 16+ | iOS 9+ | Any |
12+
913
## Platform integration
1014

1115
### Android integration

‎packages/image_picker/image_picker/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 0.8.4+11
26

37
* Fixes Activity leak.

‎packages/image_picker/image_picker/README.md

+17-11
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
A Flutter plugin for iOS and Android for picking images from the image library,
66
and taking new pictures with the camera.
77

8+
| | Android | iOS | Web |
9+
|-------------|---------|--------|----------------------------------|
10+
| **Support** | SDK 21+ | iOS 9+ | [See `image_picker_for_web `][1] |
11+
812
## Installation
913

1014
First, add `image_picker` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).
@@ -26,9 +30,9 @@ Add the following keys to your _Info.plist_ file, located in `<project root>/ios
2630

2731
Starting with version **0.8.1** the Android implementation support to pick (multiple) images on Android 4.3 or higher.
2832

29-
No configuration required - the plugin should work out of the box. It is
33+
No configuration required - the plugin should work out of the box. It is
3034
however highly recommended to prepare for Android killing the application when
31-
low on memory. How to prepare for this is discussed in the [Handling
35+
low on memory. How to prepare for this is discussed in the [Handling
3236
MainActivity destruction on Android](#handling-mainactivity-destruction-on-android)
3337
section.
3438

@@ -60,12 +64,12 @@ import 'package:image_picker/image_picker.dart';
6064
### Handling MainActivity destruction on Android
6165

6266
When under high memory pressure the Android system may kill the MainActivity of
63-
the application using the image_picker. On Android the image_picker makes use
64-
of the default `Intent.ACTION_GET_CONTENT` or `MediaStore.ACTION_IMAGE_CAPTURE`
65-
intents. This means that while the intent is executing the source application
67+
the application using the image_picker. On Android the image_picker makes use
68+
of the default `Intent.ACTION_GET_CONTENT` or `MediaStore.ACTION_IMAGE_CAPTURE`
69+
intents. This means that while the intent is executing the source application
6670
is moved to the background and becomes eligable for cleanup when the system is
67-
low on memory. When the intent finishes executing, Android will restart the
68-
application. Since the data is never returned to the original call use the
71+
low on memory. When the intent finishes executing, Android will restart the
72+
application. Since the data is never returned to the original call use the
6973
`ImagePicker.retrieveLostData()` method to retrieve the lost data. For example:
7074

7175
```dart
@@ -85,9 +89,9 @@ Future<void> getLostData() async {
8589
}
8690
```
8791

88-
This check should always be run at startup in order to detect and handle this
89-
case. Please refer to the
90-
[example app](https://pub.dev/packages/image_picker/example) for a more
92+
This check should always be run at startup in order to detect and handle this
93+
case. Please refer to the
94+
[example app](https://pub.dev/packages/image_picker/example) for a more
9195
complete example of handling this flow.
9296

9397
## Migrating to 0.8.2+
@@ -101,4 +105,6 @@ Starting with version **0.8.2** of the image_picker plugin, new methods have bee
101105
| `PickedFile image = await _picker.getImage(...)` | `XFile image = await _picker.pickImage(...)` |
102106
| `List<PickedFile> images = await _picker.getMultiImage(...)` | `List<XFile> images = await _picker.pickMultiImage(...)` |
103107
| `PickedFile video = await _picker.getVideo(...)` | `XFile video = await _picker.pickVideo(...)` |
104-
| `LostData response = await _picker.getLostData()` | `LostDataResponse response = await _picker.retrieveLostData()` |
108+
| `LostData response = await _picker.getLostData()` | `LostDataResponse response = await _picker.retrieveLostData()` |
109+
110+
[1]: https://pub.dev/packages/image_picker_for_web#limitations-on-the-web-platform

‎packages/in_app_purchase/in_app_purchase/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 3.0.2
26

37
* Adds additional explanation on why it is important to complete a purchase.

‎packages/in_app_purchase/in_app_purchase/README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ A storefront-independent API for purchases in Flutter apps.
55
This plugin supports in-app purchases (_IAP_) through an _underlying store_,
66
which can be the App Store (on iOS) or Google Play (on Android).
77

8+
| | Android | iOS |
9+
|-------------|---------|------|
10+
| **Support** | SDK 16+ | 9.0+ |
11+
812
<p>
913
<img src="https://github.com/flutter/plugins/blob/master/packages/in_app_purchase/in_app_purchase/doc/iap_ios.gif?raw=true"
1014
alt="An animated image of the iOS in-app purchase UI" height="400"/>
@@ -32,7 +36,7 @@ your app with each store. Both stores have extensive guides:
3236
* [App Store documentation](https://developer.apple.com/in-app-purchase/)
3337
* [Google Play documentation](https://developer.android.com/google/play/billing/billing_overview)
3438

35-
> NOTE: Further in this document the App Store and Google Play will be referred
39+
> NOTE: Further in this document the App Store and Google Play will be referred
3640
> to as "the store" or "the underlying store", except when a feature is specific
3741
> to a particular store.
3842
@@ -195,12 +199,12 @@ if (_isConsumable(productDetails)) {
195199
### Completing a purchase
196200

197201
The `InAppPurchase.purchaseStream` will send purchase updates after initiating
198-
the purchase flow using `InAppPurchase.buyConsumable` or
199-
`InAppPurchase.buyNonConsumable`. After verifying the purchase receipt and the
200-
delivering the content to the user it is important to call
202+
the purchase flow using `InAppPurchase.buyConsumable` or
203+
`InAppPurchase.buyNonConsumable`. After verifying the purchase receipt and the
204+
delivering the content to the user it is important to call
201205
`InAppPurchase.completePurchase` to tell the underlying store that the
202-
purchase has been completed. Calling `InAppPurchase.completePurchase` will
203-
inform the underlying store that the app verified and processed the
206+
purchase has been completed. Calling `InAppPurchase.completePurchase` will
207+
inform the underlying store that the app verified and processed the
204208
purchase and the store can proceed to finalize the transaction and bill
205209
the end user's payment account.
206210

‎packages/ios_platform_images/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 0.2.0+4
26

37
* Internal code cleanup for stricter analysis options.

‎packages/ios_platform_images/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Flutter images.
88
When loading images from Image.xcassets the device specific variant is chosen
99
([iOS documentation](https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/)).
1010

11+
| | iOS |
12+
|-------------|------|
13+
| **Support** | 9.0+ |
14+
1115
## Usage
1216

1317
### iOS->Flutter Example

‎packages/local_auth/local_auth/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 1.1.11
26

37
* Adds support `localizedFallbackTitle` in authenticateWithBiometrics on iOS.

‎packages/local_auth/local_auth/README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ the user.
66
This means referring to biometric authentication on iOS (Touch ID or lock code)
77
and the fingerprint APIs on Android (introduced in Android 6.0).
88

9-
## Usage in Dart
9+
| | Android | iOS |
10+
|-------------|-----------|------|
11+
| **Support** | SDK 16+\* | 9.0+ |
12+
13+
## Usage
1014

1115
Import the relevant file:
1216

@@ -134,6 +138,11 @@ try {
134138
}
135139
```
136140

141+
### Android
142+
143+
\* The plugin will build and run on SDK 16+, but `isDeviceSupported()` will
144+
always return false before SDK 23 (Android 6.0).
145+
137146
## iOS Integration
138147

139148
Note that this plugin works with both Touch ID and Face ID. However, to use the latter,

‎packages/path_provider/path_provider/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 2.0.9
26

37
* Updates documentation on README.md.

‎packages/path_provider/path_provider/README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
[![pub package](https://img.shields.io/pub/v/path_provider.svg)](https://pub.dev/packages/path_provider)
44

5-
A Flutter plugin for finding commonly used locations on the filesystem.
5+
A Flutter plugin for finding commonly used locations on the filesystem.
66
Supports Android, iOS, Linux, macOS and Windows.
77
Not all methods are supported on all platforms.
88

9+
| | Android | iOS | Linux | macOS | Windows |
10+
|-------------|---------|------|-------|--------|-------------|
11+
| **Support** | SDK 16+ | 9.0+ | Any | 10.11+ | Windows 10+ |
12+
913
## Usage
1014

1115
To use this plugin, add `path_provider` as a [dependency in your pubspec.yaml file](https://flutter.dev/docs/development/platform-integration/platform-channels).
@@ -40,4 +44,3 @@ Directories support by platform:
4044
With that change, tests should be updated to mock `PathProviderPlatform` rather than `PlatformChannel`.
4145

4246
See this `path_provider` [test](https://github.com/flutter/plugins/blob/master/packages/path_provider/path_provider/test/path_provider_test.dart) for an example.
43-

‎packages/quick_actions/quick_actions/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## NEXT
22

33
* Updates minimum Flutter version to 2.8.
4+
* Adds OS version support information to README.
45

56
## 0.6.0+10
67

‎packages/quick_actions/quick_actions/README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,13 @@ Quick actions refer to the [eponymous
77
concept](https://developer.apple.com/design/human-interface-guidelines/ios/system-capabilities/home-screen-actions/)
88
on iOS and to the [App
99
Shortcuts](https://developer.android.com/guide/topics/ui/shortcuts.html) APIs on
10-
Android (introduced in Android 7.1 / API level 25). It is safe to run this plugin
11-
with earlier versions of Android as it will produce a noop.
10+
Android.
1211

13-
## Usage in Dart
12+
| | Android | iOS |
13+
|-------------|-----------|------|
14+
| **Support** | SDK 16+\* | 9.0+ |
15+
16+
## Usage
1417

1518
Initialize the library early in your application's lifecycle by providing a
1619
callback, which will then be called whenever the user launches the app via a
@@ -40,9 +43,7 @@ Please note, that the `type` argument should be unique within your application
4043
name of the native resource (xcassets on iOS or drawable on Android) that the app will display for the
4144
quick action.
4245

43-
## Getting Started
44-
45-
For help getting started with Flutter, view our online
46-
[documentation](https://flutter.dev/).
46+
### Android
4747

48-
For help on editing plugin code, view the [documentation](https://flutter.dev/docs/development/packages-and-plugins/developing-packages#plugin).
48+
\* The plugin will compile and run on SDK 16+, but will be a no-op below SDK 25
49+
(Android 7.1).

‎packages/shared_preferences/shared_preferences/CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## NEXT
2+
3+
* Adds OS version support information to README.
4+
15
## 2.0.13
26

37
* Updates documentation on README.md.

0 commit comments

Comments
 (0)