This repository has been archived by the owner on Feb 22, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[tools] Require implementation package README warning (#6459)
- Loading branch information
1 parent
7992b0f
commit 7d5ff59
Showing
51 changed files
with
615 additions
and
235 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# camera_android_camerax_example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates how to use the camera_android_camerax plugin. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,19 @@ | ||
# Testing | ||
# Platform Implementation Test App | ||
|
||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. | ||
|
||
## Testing | ||
|
||
This package uses `package:integration_test` to run its tests in a web browser. | ||
|
||
See [Plugin Tests > Web Tests](https://github.com/flutter/flutter/wiki/Plugin-Tests#web-tests) | ||
in the Flutter wiki for instructions to setup and run the tests in this package. | ||
|
||
Check [flutter.dev > Integration testing](https://flutter.dev/docs/testing/integration-tests) | ||
for more info. | ||
for more info. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# camera_windows_example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates how to use the camera_windows plugin. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
# `file_selector_ios` example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates iOS implementation of the | ||
[`file_selector` plugin](https://pub.dev/packages/file_selector). | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
11 changes: 8 additions & 3 deletions
11
packages/file_selector/file_selector_linux/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
# `file_selector_linux` example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates Linux implementation of the | ||
[`file_selector` plugin](https://pub.dev/packages/file_selector). | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
11 changes: 8 additions & 3 deletions
11
packages/file_selector/file_selector_macos/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
# `file_selector_macos` example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates macOS implementation of the | ||
[`file_selector` plugin](https://pub.dev/packages/file_selector). | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
14 changes: 12 additions & 2 deletions
14
packages/file_selector/file_selector_web/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,19 @@ | ||
# Testing | ||
# Platform Implementation Test App | ||
|
||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. | ||
|
||
## Testing | ||
|
||
This package uses `package:integration_test` to run its tests in a web browser. | ||
|
||
See [Plugin Tests > Web Tests](https://github.com/flutter/flutter/wiki/Plugin-Tests#web-tests) | ||
in the Flutter wiki for instructions to setup and run the tests in this package. | ||
|
||
Check [flutter.dev > Integration testing](https://flutter.dev/docs/testing/integration-tests) | ||
for more info. | ||
for more info. |
11 changes: 8 additions & 3 deletions
11
packages/file_selector/file_selector_windows/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
# `file_selector_windows` Example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates Windows implementation of the | ||
[`file_selector` plugin](https://pub.dev/packages/file_selector). | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
10 changes: 8 additions & 2 deletions
10
packages/google_maps_flutter/google_maps_flutter_android/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# google_maps_flutter_example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates how to use the google_maps_flutter plugin. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
10 changes: 8 additions & 2 deletions
10
packages/google_maps_flutter/google_maps_flutter_ios/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# google_maps_flutter_example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates how to use the google_maps_flutter plugin. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 8 additions & 2 deletions
10
packages/google_sign_in/google_sign_in_android/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# google_sign_in_android example | ||
# Platform Implementation Test App | ||
|
||
Exercises the Android implementation of `GoogleSignInPlatform`. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
10 changes: 8 additions & 2 deletions
10
packages/google_sign_in/google_sign_in_ios/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# google_sign_in_ios example | ||
# Platform Implementation Test App | ||
|
||
Exercises the iOS implementation of `GoogleSignInPlatform`. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
14 changes: 12 additions & 2 deletions
14
packages/google_sign_in/google_sign_in_web/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,19 @@ | ||
# Testing | ||
# Platform Implementation Test App | ||
|
||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. | ||
|
||
## Testing | ||
|
||
This package uses `package:integration_test` to run its tests in a web browser. | ||
|
||
See [Plugin Tests > Web Tests](https://github.com/flutter/flutter/wiki/Plugin-Tests#web-tests) | ||
in the Flutter wiki for instructions to setup and run the tests in this package. | ||
|
||
Check [flutter.dev > Integration testing](https://flutter.dev/docs/testing/integration-tests) | ||
for more info. | ||
for more info. |
10 changes: 8 additions & 2 deletions
10
packages/image_picker/image_picker_android/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# image_picker_example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates how to use the `image_picker` plugin. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
12 changes: 11 additions & 1 deletion
12
packages/image_picker/image_picker_for_web/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# image_picker_example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates how to use the `image_picker` plugin. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
10 changes: 8 additions & 2 deletions
10
packages/image_picker/image_picker_windows/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
# image_picker_windows_example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates how to use the image_picker_windows plugin. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
63 changes: 7 additions & 56 deletions
63
packages/in_app_purchase/in_app_purchase_android/example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,9 @@ | ||
# In App Purchase Example | ||
# Platform Implementation Test App | ||
|
||
Demonstrates how to use the In App Purchase Android (IAP) Plugin. | ||
This is a test app for manual testing and automated integration testing | ||
of this platform implementation. It is not intended to demonstrate actual use of | ||
this package, since the intent is that plugin clients use the app-facing | ||
package. | ||
|
||
## Getting Started | ||
|
||
### Preparation | ||
|
||
There's a significant amount of setup required for testing in-app purchases | ||
successfully, including registering new app IDs and store entries to use for | ||
testing in the Play Developer Console. Google Play requires developers to | ||
configure an app with in-app items for purchase to call their in-app-purchase | ||
APIs. The Google Play Store has extensive documentation on how to do this, and | ||
we've also included a high level guide below. | ||
|
||
* [Google Play Billing Overview](https://developer.android.com/google/play/billing/billing_overview) | ||
|
||
### Android | ||
|
||
1. Create a new app in the [Play Developer | ||
Console](https://play.google.com/apps/publish/) (PDC). | ||
|
||
2. Sign up for a merchant's account in the PDC. | ||
|
||
3. Create IAPs in the PDC available for purchase in the app. The example assumes | ||
the following SKU IDs exist: | ||
|
||
- `consumable`: A managed product. | ||
- `upgrade`: A managed product. | ||
- `subscription_silver`: A lower level subscription. | ||
- `subscription_gold`: A higher level subscription. | ||
|
||
Make sure that all of the products are set to `ACTIVE`. | ||
|
||
4. Update `APP_ID` in `example/android/app/build.gradle` to match your package | ||
ID in the PDC. | ||
|
||
5. Create an `example/android/keystore.properties` file with all your signing | ||
information. `keystore.example.properties` exists as an example to follow. | ||
It's impossible to use any of the `BillingClient` APIs from an unsigned APK. | ||
See | ||
[here](https://developer.android.com/studio/publish/app-signing#secure-shared-keystore) | ||
and [here](https://developer.android.com/studio/publish/app-signing#sign-apk) | ||
for more information. | ||
|
||
6. Build a signed apk. `flutter build apk` will work for this, the gradle files | ||
in this project have been configured to sign even debug builds. | ||
|
||
7. Upload the signed APK from step 6 to the PDC, and publish that to the alpha | ||
test channel. Add your test account as an approved tester. The | ||
`BillingClient` APIs won't work unless the app has been fully published to | ||
the alpha channel and is being used by an authorized test account. See | ||
[here](https://support.google.com/googleplay/android-developer/answer/3131213) | ||
for more info. | ||
|
||
8. Sign in to the test device with the test account from step #7. Then use | ||
`flutter run` to install the app to the device and test like normal. | ||
|
||
Unless you are making changes to this implementation package, this example is | ||
very unlikely to be relevant. |
Oops, something went wrong.