GitHub App 및 권한
HeyDeer는 개인 계정이나 조직에 설치된 GitHub App을 통해 작동합니다. HeyDeer가 읽고 검토할 수 있는 저장소는 직접 선택합니다.
HeyDeer 설치하기
각 워크스페이스는 개인 계정이나 조직 중 하나의 GitHub 계정에 속합니다.
- GitHub에서 설치 또는 다른 계정에 설치를 선택하세요. 처음 설정할 때는 저장소 연결 아래에 있습니다. 나중에 다른 계정을 연결하려면 먼저 워크스페이스 메뉴에서 워크스페이스 추가를 선택하세요.
- GitHub에서 계정을 선택한 다음, HeyDeer가 검토할 수 있는 저장소를 선택하세요.
- GitHub에서 확인하세요. 그러면 HeyDeer가 해당 계정의 워크스페이스를 엽니다.
조직에서는 소유자만 GitHub App을 설치할 수 있으며, 소유자가 아니면 GitHub가 소유자에게 요청을 보냅니다. 요청이 대기 중인 동안 HeyDeer에는 GitHub 소유자의 승인을 기다리는 중이 표시되며, 워크스페이스 관리자는 그동안에도 설정을 구성할 수 있습니다.
소유자가 승인하면 워크스페이스가 자동으로 연결되고, HeyDeer가 워크스페이스 알림 주소로 이메일을 보냅니다.
저장소 추가
GitHub에서 Only select repositories를 선택하고 검토할 저장소를 고르세요. All repositories를 선택하면 나중에 만든 저장소도 포함됩니다.
나중에 저장소를 추가하려면 저장소 페이지에서 저장소 추가를 선택하거나, 워크스페이스 설정 → GitHub 연결에서 GitHub 접근 권한 관리를 선택하세요. GitHub에서 변경 사항을 저장할 수 있는 사람은 GitHub 계정의 소유자뿐입니다. 다른 사람에게는 팀에 요청이 표시되며, 요청 내용을 복사해 소유자에게 보낼 수 있습니다.
추가된 저장소는 검토 규칙의 워크스페이스 기본값을 따릅니다. 사용자와 HeyDeer 모두 GitHub에서 저장소에 접근할 수 있어야 HeyDeer에서 그 사용자에게 저장소와 검토가 표시됩니다. 검토를 요청하려면 쓰기 권한이 필요합니다. PR 댓글 명령을 참고하세요.
권한
| 권한 | 접근 수준 | HeyDeer의 사용 목적 |
|---|---|---|
| Contents | 읽기 및 쓰기 | 코드와 이력을 읽고, HeyDeer가 시작한 검토 대화를 해결 처리하며, 수정과 @heydeer 요청을 위한 브랜치와 커밋을 푸시합니다. |
| Pull requests | 읽기 및 쓰기 | 풀 리퀘스트를 읽고, 검토·댓글·답글을 게시하며, 요청한 풀 리퀘스트를 열고 업데이트하고 병합합니다. |
| Workflows | 읽기 및 쓰기 | 수정이나 요청에서 GitHub Actions 워크플로 파일을 바꿔야 할 때 업데이트합니다. |
| Checks | 읽기 및 쓰기 | HeyDeer Review 검사를 표시하고, 검사 버튼으로 보낸 요청을 받습니다. |
| Actions | 읽기 | 실패한 GitHub Actions 작업의 로그를 읽어 Autopilot이 수정할 수 있게 합니다. |
| Issues | 읽기 및 쓰기 | @heydeer 멘션과 명령을 수신하고, 리액션으로 받았음을 알리며, 관련 이슈를 읽고, 요청한 이슈를 열고 업데이트합니다. |
| Metadata | 읽기 | 저장소의 기본 정보와 쓰기 권한이 있는 사용자 정보를 읽습니다. |
| Members(조직) | 읽기 | 워크스페이스 멤버를 나열하고, 자동 검토 필터와 수동 검토 권한의 멤버 및 팀 조건을 확인합니다. |
| Email addresses(계정) | 읽기 | 인증된 이메일을 알림 주소로 제안합니다. |
HeyDeer에 필요한 권한을 GitHub에서 부여하지 않았다면 워크스페이스 설정 → GitHub 연결에 GitHub 권한 필요 또는 추가 GitHub 권한을 부여할 수 있습니다가 표시됩니다. GitHub 계정의 소유자가 권한 요청 확인을 선택하고 GitHub에서 요청을 수락하세요.
HeyDeer가 코드와 데이터를 처리하는 방식은 보안 및 데이터 처리를 참고하세요.
계정이나 저장소가 보이지 않는 경우
연결할 때는 HeyDeer가 설치된 조직만 표시됩니다. 조직을 추가하려면 GitHub에서 설치 또는 다른 계정에 설치를 선택하고 GitHub에서 해당 조직을 고르세요. 소유자가 아니라면 GitHub가 소유자에게 요청을 보냅니다. HeyDeer가 설치된 조직이 여전히 보이지 않으면 GitHub에서 SSO로 해당 조직에 로그인한 뒤 계정이 보이지 않나요?를 열고 GitHub에 다시 로그인을 선택하세요.
소유자가 요청을 승인했을 때 조직에 워크스페이스가 없었다면, HeyDeer가 워크스페이스를 만들고 요청자를 관리자로 지정합니다.
HeyDeer에 저장소 접근 권한 복원이 표시되면, GitHub 계정이 HeyDeer에 부여된 저장소에 접근할 수 없는 상태입니다. GitHub 접근 권한 갱신을 선택하세요. 다른 경우는 문제 해결을 참고하세요.
HeyDeer의 GitHub 접근이 일시 중지되거나 제거된 경우
GitHub에서 HeyDeer가 일시 중지되면 워크스페이스 설정 → GitHub 연결에 GitHub 접근이 일시 중지됨이 표시되고 검토를 실행할 수 없습니다. GitHub 계정의 소유자가 GitHub 접근 재개를 선택하세요.
HeyDeer가 제거되면 GitHub에서 HeyDeer가 제거됨이 표시됩니다. 소유자가 HeyDeer 다시 설치를 선택하세요. 워크스페이스의 설정과 검토 기록은 유지됩니다.