Fix: Update config documentation details#102
Conversation
|
@aviisharma238 is attempting to deploy a commit to the yashdev9274's projects Team on Vercel. A member of the Team first needs to authorize it. |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
WalkthroughThis PR updates the README.md documentation to clarify ChangesConfiguration Documentation Update
Estimated Code Review Effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 240: The README currently instructs users to substitute their deployed
domain for the GitHub OAuth callback, but the code in
apps/supercode-cli/server/src/lib/auth.ts hardcodes
https://supercode-terminal.vercel.app/api/auth/callback/github; update either
the README to show the exact production callback URL
(https://supercode-terminal.vercel.app/api/auth/callback/github) or, preferably,
modify auth.ts (look for the hardcoded callback constant or function that builds
the callback URL, e.g., AUTH_CALLBACK_URL or getCallbackUrl) to read the
callback from an environment variable (e.g., NEXTAUTH_URL or
GITHUB_CALLBACK_URL) and document that env var in the README so the runtime and
docs match.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| 1. Go to [GitHub Developer Settings](https://github.com/settings/developers) | ||
| 2. Create a new OAuth App | ||
| 3. Set Authorization callback URL: `http://localhost:3000/api/auth/callback/github` | ||
| 3. Set Authorization callback URL: `http://localhost:3000/api/auth/callback/github` (for local development). In production, use your deployed domain, e.g., `https://your-app.com/api/auth/callback/github`. |
There was a problem hiding this comment.
Use the exact production callback URL here.
The current runtime hardcodes https://supercode-terminal.vercel.app/api/auth/callback/github in apps/supercode-cli/server/src/lib/auth.ts, so telling users to substitute any deployed domain will break GitHub OAuth unless the code is changed too.
Suggested edit
-3. Set Authorization callback URL: `http://localhost:3000/api/auth/callback/github` (for local development). In production, use your deployed domain, e.g., `https://your-app.com/api/auth/callback/github`.
+3. Set Authorization callback URL: `http://localhost:3000/api/auth/callback/github` (for local development). In production, use `https://supercode-terminal.vercel.app/api/auth/callback/github` unless `apps/supercode-cli/server/src/lib/auth.ts` is updated to derive this from `BETTER_AUTH_URL`.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 240, The README currently instructs users to substitute
their deployed domain for the GitHub OAuth callback, but the code in
apps/supercode-cli/server/src/lib/auth.ts hardcodes
https://supercode-terminal.vercel.app/api/auth/callback/github; update either
the README to show the exact production callback URL
(https://supercode-terminal.vercel.app/api/auth/callback/github) or, preferably,
modify auth.ts (look for the hardcoded callback constant or function that builds
the callback URL, e.g., AUTH_CALLBACK_URL or getCallbackUrl) to read the
callback from an environment variable (e.g., NEXTAUTH_URL or
GITHUB_CALLBACK_URL) and document that env var in the README so the runtime and
docs match.
1 participant
This Pull Request was autogenerated by the Avii OSS AI Agent platform.
Issue Description
Config details inside README are outdated. Update deployment details.
Resolution Details
Summary by CodeRabbit