Skip to content

Commit 8df9848

Browse files
authored
[camera_android] Update README to encourage users to use CameraX implementation (flutter#6353)
Modify README to encourage users to opt into camera_android_camerax to start ramping up usage before changing it to the default plugin implementation on Android. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use `dart format`.) - [x] I signed the [CLA]. - [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]` - [ ] I [linked to at least one issue that this PR fixes] in the description above. - [x] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes]. - [x] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style]. - [ ] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] All existing and new tests are passing. <!-- Links --> [Contributor Guide]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md [Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene [relevant style guides]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md#style [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/wiki/Chat [linked to at least one issue that this PR fixes]: https://github.com/flutter/flutter/wiki/Tree-hygiene#overview [pub versioning philosophy]: https://dart.dev/tools/pub/versioning [exempt from version changes]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#version-and-changelog-updates [following repository CHANGELOG style]: https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changelog-style [test-exempt]: https://github.com/flutter/flutter/wiki/Tree-hygiene#tests
1 parent 6975ba7 commit 8df9848

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

packages/camera/camera_android/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
## NEXT
1+
## 0.10.8+17
22

33
* Updates minimum supported SDK version to Flutter 3.13/Dart 3.1.
44
* Updates compileSdk version to 34.
5+
* Updates `README.md` to encourage developers to opt into `camera_android_camerax`.
56

67
## 0.10.8+16
78

packages/camera/camera_android/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
The Android implementation of [`camera`][1].
44

5+
*Note*: [`camera_android_camerax`][3] will become the default implementation of
6+
`camera` on Android by May 2024, so **we strongly encourage you to opt into it**
7+
by using [these instructions][4]. If any [limitations][5] of `camera_android_camerax`
8+
prevent you from using it or if you run into any problems, please report these
9+
issues under [`flutter/flutter`][5] with `[camerax]` in the title.
10+
511
## Usage
612

713
This package is [endorsed][2], which means you can simply use `camera`
@@ -13,3 +19,6 @@ should add it to your `pubspec.yaml` as usual.
1319

1420
[1]: https://pub.dev/packages/camera
1521
[2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
22+
[3]: https://pub.dev/packages/camera_android_camerax
23+
[4]: https://pub.dev/packages/camera_android_camerax#usage
24+
[5]: https://pub.dev/packages/camera_android_camerax#limitations

packages/camera/camera_android/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: Android implementation of the camera plugin.
33
repository: https://github.com/flutter/packages/tree/main/packages/camera/camera_android
44
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
55

6-
version: 0.10.8+16
6+
version: 0.10.8+17
77

88
environment:
99
sdk: ^3.1.0

0 commit comments

Comments
 (0)