docs(auth): add manual OAuth client and browser consent guidance#29
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the project's authentication documentation by providing detailed instructions for manual OAuth client setup in Google Cloud Console and clarifying browser-assisted authentication processes. The changes aim to improve user experience by addressing common configuration challenges and consent issues, ensuring smoother integration for users requiring explicit control over their OAuth setup. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds valuable documentation for users who need to manually configure their OAuth client in Google Cloud Console. The new sections in the README provide clear, step-by-step instructions for creating an OAuth client and handling the browser-based authentication flow. I've suggested a small improvement to the URLs in the documentation to make them more direct and robust.
Note: Security Review has been skipped due to the limited scope of the PR.
…tials Update the OAuth setup section to use the canonical, stable Cloud Console URLs as suggested in Gemini review (PR googleworkspace#29): - /auth/overview → /apis/credentials/consent (matches the actual page title) - /auth/clients → /apis/credentials (more direct, avoids redirect)
🦋 Changeset detectedLatest commit: 806b8e7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
🤖 Bot triage updateFixed in commit 806b8e7Addressed Gemini review comment (README.md:107): Updated the OAuth setup section URLs to use canonical, stable Cloud Console paths as suggested:
Labels updated to match actual Cloud Console page titles: "OAuth consent screen" and "Credentials". CI status: All checks pass ✅ except API Smoketest ❌ — this fails because |
Review comments addressed ✅The Gemini code review suggestion was applied in commit Changes made:
Quality checks:
|
|
/gemini review |
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
jpoehnelt
left a comment
jpoehnelt
left a comment
There was a problem hiding this comment.
Documentation-only PR — clear and well-structured.
A few suggestions:
-
"Agent-assisted flow" section — the instructions are practical, but the phrase "the agent opens the URL, selects account, handles consent prompts" is fairly high-level. Consider linking to or referencing the
AGENTS.mdfile, which already describes the security model, so readers understand the trust boundary. -
~/.config/gws/client_secret.jsonpath — this is hardcoded in the README but the actual config dir is computed at runtime viaconfig_dir(). On non-XDG platforms (macOS withAPPDATAnot set, Windows) the path may differ. A note thatgws auth statusprints the active config directory would help users confirm the right location. -
"Testing mode" phrasing — "testing mode" in the OAuth consent screen refers specifically to the Google OAuth app publish state, not to any
gws-internal test mode. Adding a parenthetical "(Google OAuth app publish state)" would reduce confusion. -
Changeset — patch-level changeset is appropriate for a docs-only change.
LGTM — fills a real gap in the getting-started experience.
|
Follow-up on Gemini URL guidance:\n\n- README now uses canonical Cloud Console URLs for consent and credentials pages (no redirect-dependent links).\n- Resolving the remaining thread as addressed. |
…tials Update the OAuth setup section to use the canonical, stable Cloud Console URLs as suggested in Gemini review (PR googleworkspace#29): - /auth/overview → /apis/credentials/consent (matches the actual page title) - /auth/clients → /apis/credentials (more direct, avoids redirect)
…gleworkspace#29) * docs(auth): add manual OAuth client/browser guidance * docs(auth): use canonical Cloud Console URLs for OAuth consent/credentials Update the OAuth setup section to use the canonical, stable Cloud Console URLs as suggested in Gemini review (PR googleworkspace#29): - /auth/overview → /apis/credentials/consent (matches the actual page title) - /auth/clients → /apis/credentials (more direct, avoids redirect)
2 participants
Summary
Adds explicit docs for cases where users/agents need to manually configure OAuth in Google Cloud Console.
Included
client_secret.json(~/.config/gws/client_secret.json)Also includes a patch changeset.
Fixes #24
Fixes #25