|
| 1 | +title: Announcing our GitHub App beta |
| 2 | +date: 2025-06-24 |
| 3 | +description: |
| 4 | +category: Feature announcement |
| 5 | +tags: website, migration, github, authentication |
| 6 | +authors: Santos Gallegos |
| 7 | +status: published |
| 8 | +image: /images/github-app.png |
| 9 | +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> |
| 10 | + |
| 11 | +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). |
| 12 | +You can start using the new GitHub App today on Community by signing up for [beta access](#beta-access), |
| 13 | +and we plan to start testing with our Business users soon. |
| 14 | + |
| 15 | +## Why the change? |
| 16 | + |
| 17 | +GitHub Apps offer several improvements over traditional OAuth2 applications: |
| 18 | + |
| 19 | +- **More granular permissions.** |
| 20 | + The GitHub App allows us to request only the permissions we need |
| 21 | + -- no more broad, account-wide access. |
| 22 | +- **More control over repository access.** |
| 23 | + You can choose exactly which repositories Read the Docs can access, |
| 24 | + instead of granting access to all of them just to import a single one. |
| 25 | +- **No webhooks required.** |
| 26 | + The GitHub App subscribes to the events it needs automatically when you install it. |
| 27 | +- **No need for deploy keys.** |
| 28 | + To access private repositories the GitHub App uses a temporary read-only scoped token. |
| 29 | +- **Keeps working, even if access changes.** |
| 30 | + If the user who originally connected the repository loses access, |
| 31 | + the integration will continue working, since the GitHub App itself maintains access. |
| 32 | +- **Always in sync.** |
| 33 | + The GitHub App subscribes to all required events and will always keep your project up to date with your repository. |
| 34 | + |
| 35 | +## Beta access |
| 36 | + |
| 37 | +The new GitHub App already offers the same functionality as our legacy OAuth2 application, |
| 38 | +we are inviting users to try it out and provide feedback, |
| 39 | +so we can smooth out any issues before the full rollout. |
| 40 | + |
| 41 | +Some things you should know before participating in the beta: |
| 42 | + |
| 43 | +- The beta is only available for [Read the Docs Community](https://app.readthedocs.org) users. |
| 44 | + We will be expanding the beta to [Read the Docs Business](https://app.readthedocs.com) users soon. |
| 45 | +- The beta is available for existing and new users. |
| 46 | +- Existing users will be prompted to authorize our new GitHub App. |
| 47 | + Your existing Read the Docs account will be linked to the new GitHub App, |
| 48 | + and you won’t lose access to your existing projects. |
| 49 | +- You will be able to migrate your existing projects to the new GitHub App using the [migration page](https://app.readthedocs.org/accounts/migrate-to-github-app/). |
| 50 | +- Your existing projects will continue working using the legacy OAuth2 application, |
| 51 | + you don't need to migrate them immediately. |
| 52 | +- Once you have connected your account to the new GitHub App, |
| 53 | + you won't be able to link projects to repositories authorized for the legacy OAuth2 application. |
| 54 | + You'll need to install the GitHub App into the repository before connecting it to a project on Read the Docs. |
| 55 | +- We recommend that you don't revoke access to the legacy OAuth2 application until the end of the beta period. |
| 56 | + |
| 57 | +If you would like to participate in the beta, you can follow these steps: |
| 58 | + |
| 59 | +- If you are an existing user with your GitHub account already linked to Read the Docs, |
| 60 | + you can start the migration process from the [migration page](https://app.readthedocs.org/accounts/migrate-to-github-app/). |
| 61 | +- If you are a new user, from the [signup page](https://app.readthedocs.org/accounts/signup/) click on "Sign up using GitHub", |
| 62 | + and select "Sign up using GitHub App". |
| 63 | +- If you are an existing user, but you don't have your GitHub account linked to Read the Docs, |
| 64 | + from the [connected services pages](https://app.readthedocs.org/accounts/3rdparty/) click on "Add new connection", |
| 65 | + select "Connect to GitHub", and then select "Connect to GitHub App". |
| 66 | + |
| 67 | +You can read more in [our documentation](https://docs.readthedocs.com/platform/stable/reference/git-integration.html#github-app). |
| 68 | +If you run into issues or have questions, [contact us via support](https://docs.readthedocs.com/platform/stable/support.html). |
| 69 | + |
| 70 | +## The future is looking bright |
| 71 | + |
| 72 | +This is just the beginning. |
| 73 | +For now, we’re focused on ensuring a seamless transition and providing feature parity with our legacy integration. |
| 74 | +But looking ahead, the GitHub App will enable us to build new features that are only possible with a GitHub App, |
| 75 | +and to better integrate with GitHub. |
0 commit comments