Skip to content
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

Not requesting access to private repositories on Github OAuth organization integration #10897

Open
daquinteroflex opened this issue Nov 9, 2023 · 2 comments
Labels
Feature New feature Priority: low Low priority

Comments

@daquinteroflex
Copy link

daquinteroflex commented Nov 9, 2023

What's the problem this feature will solve?

Currently we have to have two organizations, one for our private/public software development and another one for documentation development. This is really complicating our development cycle, and it would be nice not to have two organizations/multiple repositories for a single project.

The reason why we have to do this is that we do not want to give access to private repositories to readthedocs, I think understandably. We only want to use readthedocs for public ones. This would allow us to have a single organization and develop our projects integrated. Can this not be fine tuned based on how the organization plans to use it?

Read the Docs for Business asks for one additional permission (repo) to allow access to private repositories and to allow us to setup SSH keys to clone your private repositories. Unfortunately, this is the permission for read/write control of the repository but there isn’t a more granular permission that only allows setting up SSH keys for read access.

Describe the solution you'd like

Have readthedocs ask for the minimal amount of permissions based on the usage of the organization of the project. Not having to give access to private repositories. Give the option to the organization on how many features or permissions are enabled to readthedocs?

Alternative solutions

I have tried manually setting up web hooks so that one repo from one organization can trigger GitHub Actions and builds from the readthedocs accessed documentation.

Additional context

This issue

@stsewd
Copy link
Member

stsewd commented Nov 27, 2023

Hi, this is due to RTD using a GitHub OAuth application, which doesn't allow selecting which projects you want to give access, the new recommended way is to create a GitHub app https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps. We have discussed internally about migrating our GitHub OAuth app to a GitHub app, but it requires a lot of work, so we haven't given it priority.

Alternative, you can manually import your private projects https://docs.readthedocs.io/en/stable/guides/importing-private-repositories.html.

@stsewd
Copy link
Member

stsewd commented Nov 27, 2023

Link to the design doc about migrating to a GitHub application #8445.

@humitos humitos added the Feature New feature label Nov 28, 2023
@humitos humitos added the Priority: low Low priority label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature Priority: low Low priority
Projects
None yet
Development

No branches or pull requests

3 participants