GitHub app and permissions
HeyDeer works through a GitHub App installed on your personal account or organization. The installation decides which repositories HeyDeer can read and review.
Install HeyDeer
Each workspace belongs to one GitHub account. Setting one up sends you to GitHub to install the app, which in an organization only an owner can do.
Otherwise, GitHub sends the owners a request. While it’s pending, HeyDeer shows Waiting for GitHub owner approval, and admins can already configure the workspace. Once an owner approves, the workspace connects on its own and HeyDeer emails the notification address. If you asked from Add a GitHub organization, HeyDeer sets up the organization’s workspace with you as its admin.
Choose repositories
Choose Only select repositories and pick the ones to review; All repositories also adds repositories created later. To change the selection, open Organization settings → GitHub connection and select Manage GitHub access. Only a GitHub owner of the account can save changes there.
Added repositories follow the organization’s review rules. A person sees a repository and its reviews in HeyDeer when both they and the installation can access it on GitHub; requesting a review needs write access. See PR comment commands.
Organization missing? Select Add a GitHub organization. For an organization that uses SSO, sign in through SSO on GitHub first, then select Reauthorize GitHub.
Permissions
| Permission | Access | What HeyDeer uses it for |
|---|---|---|
| Contents | Read and write | Read code and history. GitHub requires write access to resolve review threads; HeyDeer uses it only for its own threads. |
| Pull requests | Read and write | Read pull requests and publish reviews, comments, and replies. |
| Checks | Read and write | Show the HeyDeer Review check and receive its button requests. |
| Issues | Read | Receive PR comment commands and read linked issues. |
| Metadata | Read | Read basic repository information and who has write access. |
| Members (organization) | Read | List workspace members and match member and team rules. |
| Email addresses (account) | Read | Suggest your verified email as the notification address. |
If HeyDeer needs a permission the installation hasn’t granted, Organization settings → GitHub connection shows GitHub permission required. Select Review permission request so an owner can accept it on GitHub.