Connect your project to GitHub
Complete guide to permissions and installation of the BrainGrid GitHub App
Installing the BrainGrid GitHub App requires specific permissions on your GitHub repository. This guide explains who can install the app and how to get the necessary permissions.
Permission Requirements
You must have Admin or Owner permissions to install the BrainGrid GitHub App on a repository.
Who Can Install GitHub Apps?
| Role | Can Install? | Limitations |
|---|---|---|
| Organization Owner | ✅ Yes | Can install on any repository in the organization |
| Repository Admin | ✅ Yes* | Only on repos where they have admin rights, and only if the app doesn't request org-level permissions |
| Personal Repo Owner | ✅ Yes | Full control over their personal repositories |
| Maintainer/Write/Triage/Read | ❌ No | Can request installation, but owner must approve |
Important: Organization owners can restrict repository admins from installing GitHub Apps in their organization settings.
Installation Steps
Check Your Permissions
Before starting, verify you have the necessary permissions:
- Go to your repository on GitHub
- Click Settings (if you don't see it, you don't have admin access)
- Look for Collaborators & teams in the sidebar
If you can't access Settings, you'll need to request admin access first.
Start the Installation
Go to the Integrations section in the BrainGrid console.
Or click Connect GitHub from your BrainGrid dashboard.
Select Installation Location
Choose where to install:
- Personal account: Select your username
- Organization: Select the organization (you must be an owner or admin)
If you're not an owner/admin, you'll see "Request" instead of "Install"
Choose Repository Access
Select which repositories BrainGrid can access:
All repositories
Grants access to all current and future repos
Only select repositories
Choose specific repositories from a list
We recommend selecting only the repositories you plan to use with BrainGrid
Review Permissions
Carefully review the permissions BrainGrid is requesting:
- Read access to code and metadata
- Write access to issues and pull requests
- Read access to actions and workflows
These permissions allow BrainGrid to analyze your code and validate PRs.
Complete Installation
Click the installation button:
- Install - If you have full permissions
- Install & Request - If you have partial permissions
- Request - If you need owner approval
If you see "Request", the organization owner will receive a notification to approve your request
Getting Admin Access
If you don't have the necessary permissions, here's how to get them:
For Organization Repositories
If you're an admin and need to grant access to someone:
Navigate to Repository Settings
- Go to the repository on GitHub
- Click Settings → Collaborators & teams
Add the User
- Click Add people or Add teams
- Search for the user by their GitHub username
- Select them from the dropdown
Set Admin Role
- In the role dropdown, select Admin
- Click Add [username] to [repository]
The user now has admin access and can install GitHub Apps.
For Personal Repositories
Personal repositories only have two roles: Owner (you) and Collaborators (write access only).
Collaborators cannot have admin rights on personal repositories.
If you need multiple admins, consider:
- Transfer to an Organization: Move your repository to an organization where you can assign admin roles
- Create an Organization: Set up a new organization for your projects
Troubleshooting
Quick Reference
Installation URL
https://github.com/apps/braingrid/installations/newRequired Permissions
- Minimum: Repository Admin (with restrictions)
- Recommended: Organization Owner (full control)
Can't Install?
- Check your repository role
- Request admin access if needed
- Or ask an admin to install for you
Next Steps
Once you've successfully installed the BrainGrid GitHub App:
