Skip to content

docs(ci): drop a wrong claim about OAuth callback URLs - #1576

Merged
FelixTJDietrich merged 1 commit into
mainfrom
fix/preview-oauth-claim
Aug 29, 2026
Merged

docs(ci): drop a wrong claim about OAuth callback URLs#1576
FelixTJDietrich merged 1 commit into
mainfrom
fix/preview-oauth-claim

Conversation

@FelixTJDietrich

@FelixTJDietrich FelixTJDietrich commented Aug 29, 2026

Copy link
Copy Markdown
Collaborator

Description

docker/preview/.env.example claimed GitHub rejects wildcard callback URLs, and concluded that one OAuth app cannot serve every pr<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 its redirect_uri from 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

  • My changeset summary reads as an operator/user-facing note — empty changeset: a comment in an example file
  • If the operator must act on this change, the changeset says how — no operator action

Summary by CodeRabbit

  • Documentation
    • Clarified the preview environment’s GitHub OAuth callback configuration requirements.
    • Explained how preview builds determine the OAuth redirect URL from the served host.
    • Corrected an example comment; no deployed behavior changes.

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
@FelixTJDietrich
FelixTJDietrich requested a review from a team as a code owner August 29, 2026 07:30
@coderabbitai

coderabbitai Bot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ea729371-bc2c-4f97-9647-f3f55458f928

📥 Commits

Reviewing files that changed from the base of the PR and between 42d5427 and 139df18.

📒 Files selected for processing (2)
  • .changeset/preview-oauth-note.md
  • docker/preview/.env.example

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The preview environment OAuth comment now documents API-host callback coverage and host-based redirect_uri construction. A changeset records the documentation correction. No deployed behavior changed.

Changes

Preview OAuth documentation

Layer / File(s) Summary
Update preview OAuth configuration guidance
docker/preview/.env.example, .changeset/preview-oauth-note.md
The example documents callback coverage for pr<id>.api.<preview zone> hosts and host-based redirect_uri construction. The changeset records that the correction does not change deployed behavior.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 139df

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)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: removing an incorrect claim about OAuth callback URLs from the preview environment documentation.
Docstring Coverage ✅ Passed 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…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

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)
  • Create PR with unit tests
  • Commit unit tests in branch fix/preview-oauth-claim

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@FelixTJDietrich
FelixTJDietrich merged commit 96bf458 into main Aug 29, 2026
28 checks passed
@FelixTJDietrich
FelixTJDietrich deleted the fix/preview-oauth-claim branch August 29, 2026 07:35
@github-actions

Copy link
Copy Markdown
Contributor

📚 Documentation Preview

Preview has been removed (PR closed)

@github-actions

Copy link
Copy Markdown
Contributor

🧩 Storybook Preview

Preview has been removed (PR closed)

@github-actions github-actions Bot added bug Something isn't working security Authentication, authorization, vulnerability fixes ci GitHub Actions, workflows, build pipeline changes infrastructure Docker, containers, and deployment infrastructure size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working ci GitHub Actions, workflows, build pipeline changes documentation Improvements or additions to documentation infrastructure Docker, containers, and deployment infrastructure security Authentication, authorization, vulnerability fixes size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant