Add Envs for Github Enterprise Oauth App

emplam27 commented 1 week ago

What this PR does / why we need it:

Added an envs for using passport-github on Github Enterprise Oauth app.

ref: https://github.com/jaredhanson/passport-github?tab=readme-ov-file#enterprise-corporate-github ref: https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps

Default value is for Github Oauth app. if yor want to Github Enterprise OAuth app, change those envs.

GITHUB_AUTHORIZATION_URL: https://github.com/login/oauth/authorize => https://ENTERPRISE_INSTANCE_URL/login/oauth/authorize
GITHUB_TOKEN_URL: https://github.com/login/oauth/access_token => https://ENTERPRISE_INSTANCE_URL/login/oauth/access_token
GITHUB_USER_PROFILE_URL: https://api.github.com/user => https://ENTERPRISE_INSTANCE_URL/api/v3/user

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

[x] Added relevant tests or not required
[x] Didn't break anything

Summary by CodeRabbit

New Features
- Enhanced GitHub authentication with new OAuth configuration variables.
- Improved GithubStrategy to utilize additional parameters for better integration with GitHub services.
Bug Fixes
- No specific bug fixes noted in this release.
Documentation
- Updated environment variable descriptions for clarity on usage in the OAuth flow.

CLAassistant commented 1 week ago

All committers have signed the CLA.

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes introduce new environment variables for GitHub OAuth in the backend/.env.development file, including GITHUB_AUTHORIZATION_URL, GITHUB_TOKEN_URL, and GITHUB_USER_PROFILE_URL. Additionally, the GithubStrategy class in backend/src/auth/github.strategy.ts has been updated to utilize these new variables in its configuration for the authentication strategy while keeping existing properties unchanged.

Changes

File	Change Summary
backend/.env.development	Added variables: `GITHUB_AUTHORIZATION_URL`, `GITHUB_TOKEN_URL`, `GITHUB_USER_PROFILE_URL` with descriptions and expected value formats. Existing variables remain unchanged.
backend/src/auth/github.strategy.ts	Modified `GithubStrategy` class to include `authorizationURL`, `tokenURL`, and `userProfileURL` properties from `ConfigService`. Existing properties remain unchanged.

Poem

In the garden where code does bloom,
New paths for GitHub, we make room.
With tokens and URLs, we set the stage,
For seamless logins, we turn the page.
Hops of joy in every line,
A rabbit's cheer for code divine! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

devleejb commented 1 week ago

Thanks for the PR. Could you sign the CLA?

emplam27 commented 1 week ago

@devleejb done! thank you :)

yorkie-team / codepair