From be2a2fc3b8167fdf0c7d7a70eae9eb79773a8004 Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Tue, 11 Apr 2023 09:43:12 -0700 Subject: [PATCH] Avoid repeating grpc version in Android documentation This removes some steps from the release process. These two locations aren't special enough in way that deserves manually changing the version each release. --- RELEASING.md | 2 -- cronet/README.md | 10 +++------- documentation/android-channel-builder.md | 9 ++------- 3 files changed, 5 insertions(+), 16 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 920ac50349..9bd20035db 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -104,8 +104,6 @@ Tagging the Release # Bump documented gRPC versions. # Also update protoc version to match protobuf version in gradle/libs.versions.toml. $ ${EDITOR:-nano -w} README.md - $ ${EDITOR:-nano -w} documentation/android-channel-builder.md - $ ${EDITOR:-nano -w} cronet/README.md $ git commit -a -m "Update README etc to reference $MAJOR.$MINOR.$PATCH" ``` diff --git a/cronet/README.md b/cronet/README.md index dbd9708717..b62ed634b0 100644 --- a/cronet/README.md +++ b/cronet/README.md @@ -22,13 +22,9 @@ See the example app at https://github.com/GoogleChrome/cronet-sample/blob/master ## Example usage: -In your app module's `build.gradle` file, include a dependency on both `grpc-cronet` and the -Google Play Services Client Library for Cronet - -``` -implementation 'io.grpc:grpc-cronet:1.54.0' -implementation 'com.google.android.gms:play-services-cronet:16.0.0' -``` +In your app module's `build.gradle` file, include a dependency on both +`io.grpc:grpc-cronet` and the Google Play Services Client Library for Cronet, +`com.google.android.gms:play-services-cronet`. In cases where Cronet cannot be loaded from Google Play services, there is a less performant implementation of Cronet's API that can be used. Depend on `org.chromium.net:cronet-fallback` diff --git a/documentation/android-channel-builder.md b/documentation/android-channel-builder.md index 4f9bbbd991..d7b07908d1 100644 --- a/documentation/android-channel-builder.md +++ b/documentation/android-channel-builder.md @@ -32,13 +32,8 @@ connection management on Android devices.* ## Example usage: -In your `build.gradle` file, include a dependency on both `grpc-android` and -`grpc-okhttp`: - -``` -implementation 'io.grpc:grpc-android:1.54.0' -implementation 'io.grpc:grpc-okhttp:1.54.0' -``` +In your `build.gradle` file, include a dependency on both `io.grpc:grpc-android` and +`io.grpc:grpc-okhttp`. You also need permission to access the device's network state in your `AndroidManifest.xml`: