docs(ci): drop a wrong claim about OAuth callback URLs - #1576
Conversation
The example said GitHub rejects wildcard callback URLs and that one app therefore cannot serve every pr<id> host, so an operator had to re-point the callback at whichever preview was being signed into. That is not true of this application: a preview deployed today was signed into without anyone touching the callback. It now states what an operator has to arrange — a callback covering pr<id>.api.<zone> — without asserting anything about what GitHub does or does not accept, which is the part that was wrong and the part this file has no need to describe. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017VKWqbmrPJFv8aKZBp36uD
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe preview environment OAuth comment now documents API-host callback coverage and host-based ChangesPreview OAuth documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This is a localized documentation correction with no deployed behavior change, so no actionable merge-blocking risk remains beyond normal checks. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
📚 Documentation Preview
|
🧩 Storybook Preview
|
Description
docker/preview/.env.exampleclaimed GitHub rejects wildcard callback URLs, and concluded that one OAuth app cannot serve everypr<id>host, so an operator must re-point the callback at whichever preview is being signed into.That is wrong for this application. The preview for #1538 was deployed and signed into — full staging data behind a real GitHub login — with nobody touching the callback.
The comment now states the requirement an operator actually has to satisfy (a callback covering
pr<id>.api.<zone>, since the preview builds itsredirect_urifrom the host it is served on) and asserts nothing about GitHub's policy. That assertion was both wrong and unnecessary — this file describes what to configure, not what the provider permits.I very nearly propagated the error instead of fixing it: #1575 added a paragraph to the contributor docs repeating the claim. Closed.
How to test
CI covers this — a comment in an example file. The behaviour it describes was verified by signing in to the live preview.
Checklist
Summary by CodeRabbit