Skip to content

docs: correct the auth README and getting-started guide against the GA API surface - #2544

Merged
russellwheatley merged 15 commits into
masterfrom
docs/auth-readme-ga-api
Nov 3, 2026
Merged

russellwheatley merged 15 commits into
masterfrom
docs/auth-readme-ga-api

Conversation

@demolaf

@demolaf demolaf commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

Corrects the auth README and the getting-started guide against the 10.0.0 API surface.

Changes

  • AuthState matches the source: abstract not sealed, no data classes, Error.exception typed Exception, plus reauthenticatedUid, isNotification and the Reauthentication hierarchy.
  • MFA Configuration passes mfaConfiguration to FirebaseAuthScreen, and Error Handling covers all 21 AuthException subclasses with an else, mapping the six email-link types to their AuthUIStringProvider copy.
  • The 32-row test-tag table becomes the fui_<object>_<constant> naming rule, with the stability promise covering all of FirebaseAuthTestTags. Sign Out documents the Google and Facebook session clearing.
  • Theming points at the slot APIs for layout changes, and the getting-started guide is corrected against the GA API, with rememberAuthConfiguration now remembering and the createAuthFlow example launching once rather than on every recreation.
  • Snippets that call @Composable APIs alongside applicationContext now sit in setContent { }, where both resolve.
  • Drops every beta marker now that 10.0.0 has shipped: the install coordinates, the beta banners, and Config.kt / gradle.properties, which still read 10.0.0-beta05. Documented third-party versions are pinned to the ones 10.0.0 ships with.
  • Fixes two AuthException messages that read "You are are attempting...".
  • Compiles the password-requirement number pattern in AuthException once instead of on every call.

Maintainer note: Fixes internal CPRN-605, Fixes internal CPRN-616, Refs internal CPRN-490

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request centralizes the Android Lint configuration in the root build file, applying a uniform policy across all subprojects and removing redundant lint blocks from individual modules. It also refactors error handling and localization in the auth module, mapping specific Firebase Auth error codes to localized messages via AuthUIStringProvider, and improves session cleanup during sign-out. Additionally, ContinueUrlBuilder was refactored to use Uri for safer parameter appending, and numerous localized string resources were updated. The review feedback recommends ensuring the tools namespace is declared in all XML files using tools:ignore to prevent compilation errors, and suggests optimizing regex instantiation by extracting the pattern to a companion object constant.

Comment thread auth/src/main/res/values/strings.xml Resolved
@demolaf
demolaf force-pushed the docs/auth-readme-ga-api branch from a13ce0a to f0883e5 Compare October 28, 2026 13:12
@demolaf demolaf changed the title docs(auth): correct the auth README against the GA API surface, and fix two broken exception messages docs: correct the auth README and getting-started guide against the GA API surface Nov 3, 2026

@russellwheatley russellwheatley left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One change on the getting-started sign-in snippet. Everything else I checked against the source lines up 👍

Comment thread GETTING_STARTED.md Resolved
@russellwheatley
russellwheatley merged commit b74e501 into master Nov 3, 2026
19 checks passed
@russellwheatley
russellwheatley deleted the docs/auth-readme-ga-api branch November 3, 2026 16:52
@github-project-automation github-project-automation Bot moved this from Backlog to Done in studio-2394994192-60a69 Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants