docs: fix README feature list and RefreshCookieName comment#254
Merged
veverkap merged 1 commit intoMay 11, 2026
Merged
Conversation
- Add 'generic OAuth2 login (GitHub, Discord, Slack, and any custom provider)' to the intro feature list; the OAuth2Handler and built-in providers (GitHubProvider, GoogleOAuth2Provider) exist in the codebase but were absent from the README description (present in docs/index.md) - Correct the RefreshCookieName quick-start comment from 'optional' to 'required when Sessions is set'; AuthHandler.Validate() enforces this constraint and returns an error when Sessions is non-nil but RefreshCookieName is empty Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates top-level documentation to accurately reflect existing OAuth2 support and handler configuration requirements.
Changes:
- Add generic OAuth2 login (e.g., GitHub/Discord/Slack/custom providers) to the README feature list to match the existing
OAuth2Handlerfunctionality documented elsewhere. - Correct the Quick Start
RefreshCookieNamecomment to indicate it’s required whenSessionsis set (consistent withAuthHandler.Validate()behavior).
Show a summary per file
| File | Description |
|---|---|
| README.md | Aligns the feature list with existing OAuth2 capabilities and fixes Quick Start guidance for RefreshCookieName when Sessions is enabled. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Greptile Summary
This PR makes two documentation-only corrections to
README.md: it adds generic OAuth2 login to the intro feature list (matching the existingOAuth2Handlerand built-in providers already present in the codebase), and updates theRefreshCookieNamequick-start comment from "optional" to "required when Sessions is set" (matchingAuthHandler.Validate()enforcement and theauth.gostruct comment).handler/oauth2.goand the built-inGitHubProvider/GoogleOAuth2Providerimplementations.RefreshCookieNamecorrection aligns the quick-start comment with actual runtime behaviour, but the equivalent comment in the detailedAuthHandlerreference block (line 520) still reads// optionaland was not updated in this PR.Confidence Score: 4/5
Safe to merge — documentation-only change with no runtime impact.
Both changes are accurate relative to the source code. The only remaining gap is a parallel "optional" label for RefreshCookieName in the detailed AuthHandler reference block that this PR did not touch, leaving the README internally inconsistent on that point.
README.md line 520 — the detailed AuthHandler struct example still labels RefreshCookieName as optional.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[AuthHandler configured] --> B{Sessions set?} B -- No --> C[RefreshCookieName optional\nRefresh tokens disabled] B -- Yes --> D{RefreshCookieName set?} D -- No --> E[Validate returns error\ntoken issuance HTTP 500] D -- Yes --> F[Refresh token issued\nstored in HttpOnly cookie]Comments Outside Diff (1)
README.md, line 520 (link)RefreshCookieNamefield is still labelled// optionalin the detailedAuthHandlerreference block further down in the README. This is now inconsistent with the quick-start comment fixed in this PR and with theauth.gosource comment ("Required when Sessions is non-nil").AuthHandler.Validate()returns an error whenSessionsis set andRefreshCookieNameis empty, so calling it optional is misleading.Prompt To Fix With AI
Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: fix README feature list and Refres..." | Re-trigger Greptile