[google_sign_in] Adopt code excerpts in README #5521

mike-v2 · 2023-11-29T22:37:51Z

Improves README example and updates it to use code excerpts.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

mike-v2 · 2023-11-29T22:41:52Z

I was able to get the code excerpts from the example/lib/main.dart file, but they didn't always appear verbatim. Let me know if the differences outweigh the benefit of not creating an extra file, or if I should tweak the example file to better match the original README snippets.
If you do want me to create a separate file, please advise on how to structure the tests, since it seems the README code is mainly making API calls.

stuartmorgan-g

LGTM with some minor changes, thanks!

(Several of these are actually not very good code, like the global sign-in object, but not-great code that we know compiles is still an improvement!)

stuartmorgan-g · 2023-12-04T21:13:51Z

packages/google_sign_in/google_sign_in/README.md

@@ -66,25 +66,32 @@ To use this plugin, follow the

 Add the following import to your Dart code:

+<?code-excerpt "example/lib/main.dart (Import)"?>
 ```dart
 import 'package:google_sign_in/google_sign_in.dart';
 ```


We can just remove from 67 to here; this information is in the installation page instructions.

stuartmorgan-g · 2023-12-04T21:14:04Z

packages/google_sign_in/google_sign_in/example/lib/main.dart

@@ -9,12 +9,15 @@ import 'dart:convert' show json;

 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
+// #docregion Import


(And remove this.)

stuartmorgan-g · 2023-12-04T21:20:17Z

packages/google_sign_in/google_sign_in/example/lib/main.dart

@@ -59,7 +63,9 @@ class _SignInDemoState extends State<SignInDemo> {
      bool isAuthorized = account != null;
      // However, in the web...
      if (kIsWeb && account != null) {
+// #docregion CanAccessScopes


Let's put this just above line 62 instead; it's all relevant to what the example is talking about.

stuartmorgan-g · 2023-12-04T21:20:25Z

packages/google_sign_in/google_sign_in/example/lib/main.dart

        isAuthorized = await _googleSignIn.canAccessScopes(scopes);
+// #enddocregion CanAccessScopes


And then this will move down one line.

stuartmorgan-g · 2023-12-04T21:22:01Z

@tarrinneal for second review once the changes are made.

Remove Import snippet since it's in the installation page instructions Expand CanAccessScopes snippet to include additional pertinent information

tarrinneal

one nit

packages/google_sign_in/google_sign_in/example/lib/main.dart

auto-submit · 2023-12-07T08:32:24Z

auto label is removed for flutter/packages/5521, due to - The status or check suite Windows_x64 dart_unit_tests_shard_1 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

The status or check suite Linux_android android_platform_tests_shard_4 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2023-12-08T15:45:50Z

auto label is removed for flutter/packages/5521, due to - The status or check suite Mac_arm64 ios_platform_tests_shard_2 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2023-12-11T19:08:07Z

auto label is removed for flutter/packages/5521, due to - The status or check suite Linux dart_unit_test_shard_1 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

…ges#5521)

flutter/packages@b5958e2...1151191 2023-12-14 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 2.22.8 to 3.22.11 (flutter/packages#5674) 2023-12-13 [email protected] [ci][web] Ignore always_specify_types for JSArray. (flutter/packages#5669) 2023-12-13 [email protected] [tool] Add support for `.java`, `.gradle`, `.sh`, and `.m` filesâ�¦ (flutter/packages#5567) 2023-12-13 [email protected] [google_sign_in] Update (web) example app. (flutter/packages#5634) 2023-12-13 [email protected] [path_provider] De-flake getExternalStorageDirectories test (flutter/packages#5628) 2023-12-13 [email protected] [google_sign_in_web] Stop relying on framework internals. (flutter/packages#5660) 2023-12-13 [email protected] [Android] Bump Gradle version to 7.6.3 (flutter/packages#5522) 2023-12-13 [email protected] [google_sign_in] Adopt code excerpts in README (flutter/packages#5521) 2023-12-13 [email protected] [css_colors] Adopt code excerpts in README (flutter/packages#5478) 2023-12-13 [email protected] [webview_flutter] Support for handling basic authentication requests (Android) (flutter/packages#5454) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

[google_sign_in] Adopt code excerpts in README

666a981

mike-v2 requested a review from stuartmorgan-g as a code owner November 29, 2023 22:37

github-actions bot added the p: google_sign_in label Nov 29, 2023

update code excerpts

43295f3

stuartmorgan-g approved these changes Dec 4, 2023

View reviewed changes

stuartmorgan-g requested a review from tarrinneal December 4, 2023 21:21

Update code snippets

8f4d87f

Remove Import snippet since it's in the installation page instructions Expand CanAccessScopes snippet to include additional pertinent information

tarrinneal approved these changes Dec 6, 2023

View reviewed changes

packages/google_sign_in/google_sign_in/example/lib/main.dart Outdated Show resolved Hide resolved

Fix comment wording

2abcb1e

tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 7, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Dec 7, 2023

Merge branch 'main' into code-excerpts-google-sign-in

c119cbc

tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 8, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Dec 8, 2023

stuartmorgan-g added 3 commits December 8, 2023 12:23

Merge branch 'main' into code-excerpts-google-sign-in

4af69de

Merge branch 'main' into code-excerpts-google-sign-in

86c1299

Merge branch 'main' into code-excerpts-google-sign-in

9e6ba7f

tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 11, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Dec 11, 2023

stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 13, 2023

auto-submit bot merged commit 12b3d59 into flutter:main Dec 13, 2023

engine-flutter-autoroll mentioned this pull request Dec 14, 2023

Roll Packages from b5958e2a8b49 to 1151191c8c13 (10 revisions) flutter/flutter#140154

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Dec 14, 2023

12b3d59 [google_sign_in] Adopt code excerpts in README (flutter/packa…

c3df3b2

…ges#5521)

reidbaker mentioned this pull request Jan 12, 2024

Dialog Debug #5881

Closed

reidbaker mentioned this pull request Jan 19, 2024

[in_app_purchase] Add play country code api #5941

Merged

12 tasks

reidbaker mentioned this pull request Feb 19, 2024

[in_app_purchase_android] Add UserChoiceBilling mode. #6162

Merged

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[google_sign_in] Adopt code excerpts in README #5521

[google_sign_in] Adopt code excerpts in README #5521

Uh oh!

mike-v2 commented Nov 29, 2023

Uh oh!

mike-v2 commented Nov 29, 2023

Uh oh!

stuartmorgan-g left a comment

Uh oh!

stuartmorgan-g Dec 4, 2023

Uh oh!

stuartmorgan-g Dec 4, 2023

Uh oh!

stuartmorgan-g Dec 4, 2023

Uh oh!

stuartmorgan-g Dec 4, 2023

Uh oh!

stuartmorgan-g commented Dec 4, 2023

Uh oh!

tarrinneal left a comment

Uh oh!

Uh oh!

auto-submit bot commented Dec 7, 2023

Uh oh!

auto-submit bot commented Dec 8, 2023

Uh oh!

auto-submit bot commented Dec 11, 2023

Uh oh!

Uh oh!

		isAuthorized = await _googleSignIn.canAccessScopes(scopes);
		// #enddocregion CanAccessScopes

[google_sign_in] Adopt code excerpts in README #5521

[google_sign_in] Adopt code excerpts in README #5521

Uh oh!

Conversation

mike-v2 commented Nov 29, 2023

Pre-launch Checklist

Uh oh!

mike-v2 commented Nov 29, 2023

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Dec 4, 2023

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Dec 4, 2023

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Dec 4, 2023

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Dec 4, 2023

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g commented Dec 4, 2023

Uh oh!

tarrinneal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

auto-submit bot commented Dec 7, 2023

Uh oh!

auto-submit bot commented Dec 8, 2023

Uh oh!

auto-submit bot commented Dec 11, 2023

Uh oh!

Uh oh!