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

Pass extra environment variables for GitHub app #259

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Feb 19, 2025

stsewd added a commit to readthedocs/readthedocs.org that referenced this pull request Feb 24, 2025
Extracted from readthedocs/common#259.
The provider is not exposed to users yet, and we allow only staff users
to use it.
stsewd added a commit to readthedocs/readthedocs.org that referenced this pull request Feb 26, 2025
Extracted from readthedocs/common#259. The
provider is not exposed to users yet, and we allow only staff users to
use it (manually going to /accounts/githubapp/login).

There are steps for ops team and Eric or Anthony to do:

- Create a new GH app from
https://github.com/organizations/readthedocs/settings/apps/new (the name
will be used when we do actions as the installation, like when creating
a comment).
- Callback URL should be
https://app.readthedocs.org/accounts/githubapp/login/callback/
- Keep marked "Expire user authorization tokens"
- Don't active the webhook, since we aren't going to use it yet.
- Permissions (can be updated later if required):
- Repository permissions: Commit statuses (read and write, so we can
create commit statuses), Contents (read only, so we can clone repos with
a token), Metadata (read only, so we read the repo collaborators), Pull
requests (read and write, so we can post a comment on PRs in the
future).
- Organization permissions: Members (read only so we can read the
organization members)
- Account permissions: Email addresses (read only, so allauth can fetch
all verified emails)
- Subscribe to events (can be updated later if required): Installation
target, Member, Organization, Membership, Pull request, Push,
Repository.
- Where can this GitHub App be installed?: any account
- Copy the client ID and client secret into ops repo for the githubapp
provider, we can skip setting a webhook secret and private key, as they
won't be used for now.

Same process for the app for .com.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant