docs: add GitHub integration setup guide (ext-387) #3745
Conversation
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
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
devin-ai-integration
bot
requested review from
hassan254-prog and
lordsarcastic
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
khaliqgant
reviewed
Mar 19, 2025
docs-v2/integrations/all/github.mdx
Outdated
| @@ -57,5 +156,10 @@ _No setup guide yet._ | |||
| - There are certain API methods that only work with an OAuth App that will not work with an App. Please check the Github documentation and look for a "Works with Github Apps" header under the endpoint. | |||
| - The `github-app-oauth` is a combination of a Github App and OAuth and should be used when a Github App would need approval to be installed into an organization. | |||
| - Nango supports initiating a connection with a GitHub App using the frontend SDK, but not directly from the [GitHub Marketplace](https://github.com/marketplace). Therefore, you should encourage users to install your GitHub App from your product, rather than from the GitHub Marketplace directly. This is a limitation we plan to fix in the future. | |||
| - GitHub's OAuth implementation supports the standard authorization code grant type but does not support the implicit grant type. | |||
There was a problem hiding this comment.
This and none of the below are useful or informative gotchas. A lot of Nango's value prop is that these details are handled by Nango so our users don't have to worry about or even know these "gotchas". Please remove and note for other pull requests.
|
I've recorded a video demonstrating the complete setup process for GitHub integration. The video shows the OAuth app creation process, including navigating the developer portal, configuring redirect URIs, and setting up necessary permissions. |
|
Closing due to inactivity for more than 7 days. |
lordsarcastic
approved these changes
Mar 28, 2025
Comment on lines
+94
to
+103
| | Topic | Links | | ||
| | - | - | | ||
| | General | [GitHub Developer Documentation](https://docs.github.com/en/developers) | | ||
| | | [GitHub REST API Documentation](https://docs.github.com/en/rest) | | ||
| | OAuth | [Creating an OAuth App](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) | | ||
| | | [Authorizing OAuth Apps](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps) | | ||
| | | [OAuth Scopes for GitHub](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) | | ||
| | Comparison | [Differences between GitHub Apps and OAuth Apps](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/differences-between-github-apps-and-oauth-apps) | | ||
| | GitHub Apps | [Registering a GitHub App](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) | | ||
| | | [GitHub App Permissions](https://docs.github.com/en/rest/overview/permissions-required-for-github-apps) | |
There was a problem hiding this comment.
Put this in list form
TBonnin
added
the
never-stale
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.
GitHub Integration Documentation
This PR adds comprehensive documentation for the GitHub integration, including a detailed setup guide for creating and configuring OAuth credentials.
Changes
References
Link to Devin run: https://app.devin.ai/sessions/94f14c04f0bf4a7bb75ab740686940de
Requested by: [email protected]