-
Notifications
You must be signed in to change notification settings - Fork 8
Post: Announcing our GitHub App beta #357
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
f2953c3
Post: Welcome to our GitHub App
stsewd 4048a39
This one works
stsewd e8082f1
Apply suggestions from code review
stsewd 5324452
Merge branch 'main' into github-app
stsewd e5bfc3e
Update to mention beta
stsewd 4109fe4
Updates
stsewd 00961c2
Updates from review
stsewd b9d8a36
Update dates and steps
stsewd e74d1f6
Merge branch 'main' into github-app
stsewd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| title: Welcome to our GitHub App | ||
| date: 2025-05-15 | ||
| description: | ||
| category: Feature announcement | ||
| tags: website, migration, github, authentication | ||
| authors: Santos Gallegos | ||
| status: published | ||
| image: /images/github-app.png | ||
| image_credit: Photo by <a href="https://unsplash.com/@synkevych?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Roman Synkevych</a> on <a href="https://unsplash.com/photos/black-and-white-penguin-toy-wX2L8L-fGeA?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a> | ||
|
|
||
| We are excited to announce that we are migrating from our legacy GitHub OAuth2 application to a modern [GitHub App](https://docs.github.com/en/apps/overview). | ||
|
|
||
| ## Why the change? | ||
|
|
||
| GitHub Apps offer several improvements over traditional OAuth2 applications: | ||
|
|
||
| - **More granular permissions.** | ||
| The GitHub App allows us to request only the permissions we need | ||
| --no more broad, account-wide access. | ||
| - **More control over repository access.** | ||
| You can choose exactly which repositories Read the Docs can access, | ||
| instead of granting access to all of them just to import a single one. | ||
| - **No webhooks required.** | ||
| The GitHub App subscribes to the events it needs automatically when you install it. | ||
| - **No need for deploy keys.** | ||
| To access private repositories the GitHub App uses a temporary read-only scoped token. | ||
| - **Keeps working, even if access changes.** | ||
| If the user who originally connected the repository loses access, | ||
| the integration will continue working, since the GitHub App itself maintains access. | ||
| - **Always in sync.** | ||
| The GitHub App subscribes to all required events and will always keep your project up to date with your repository. | ||
|
|
||
| ## What’s changing? | ||
|
|
||
| We’re aiming for a smooth transition while continuing to support our legacy OAuth2 integration during this migration period. | ||
| Here’s what to expect: | ||
|
|
||
| - Existing users who sign in with GitHub will be prompted to authorize our new GitHub App. | ||
| Your existing Read the Docs account will be automatically linked, | ||
| and you won’t lose access to your existing projects. | ||
| - Existing users will be asked to migrate their accounts and projects to the new GitHub App. | ||
| - New users will use the GitHub App to sign up. | ||
| Creating an account with the legacy OAuth2 application will no longer be supported. | ||
| - The legacy OAuth2 application will be deprecated and eventually removed. | ||
| We'll continue to support current users and projects for a while, | ||
| but we strongly encourage you to migrate soon. | ||
|
|
||
| ## What do you need to do? | ||
|
|
||
| If you're already using Read the Docs with GitHub, | ||
| you'll receive a notification prompting you to visit our migration page. | ||
| This page will walk you through the process of connecting your account and projects to the new GitHub App. | ||
|
|
||
| ## The future is looking bright | ||
|
|
||
| This is just the beginning. | ||
| For now, we’re focused on ensuring a seamless transition and providing feature parity with our legacy integration. | ||
| But looking ahead, the GitHub App will enable us to build new features that are only possible with a GitHub App, | ||
| and to better integrate with GitHub. | ||
|
|
||
| You can find more details in our [documentation](https://docs.readthedocs.com/platform/stable/reference/git-integration.html). | ||
| If you run into issues or have questions, [contact us via support](https://docs.readthedocs.com/platform/stable/support.html). | ||
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.
Uh oh!
There was an error while loading. Please reload this page.