GitHub App und Berechtigungen
HeyDeer arbeitet über eine GitHub App, die in deinem persönlichen Konto oder deiner Organisation installiert ist. Du wählst, welche Repositorys HeyDeer lesen und prüfen kann.
HeyDeer installieren
Jeder Arbeitsbereich gehört zu genau einem GitHub-Konto: einem persönlichen Konto oder einer Organisation.
- Wähle Auf GitHub installieren oder Auf einem anderen Konto installieren. Bei der ersten Einrichtung findest du die Option unter Verbinde deine Repositorys. Um später ein weiteres Konto zu verbinden, wähle zuerst Arbeitsbereich hinzufügen im Arbeitsbereichsmenü.
- Wähle auf GitHub das Konto und dann die Repositorys, die HeyDeer prüfen darf.
- Bestätige auf GitHub. HeyDeer öffnet dann den Arbeitsbereich des Kontos.
In einer Organisation kann nur ein Inhaber die GitHub App installieren; andernfalls sendet GitHub den Inhabern eine Anfrage. Solange sie aussteht, zeigt HeyDeer Warten auf die Genehmigung eines GitHub-Inhabers, und Admins des Arbeitsbereichs können bereits Einstellungen konfigurieren.
Sobald ein Inhaber genehmigt, wird der Arbeitsbereich automatisch verbunden, und HeyDeer sendet eine E-Mail an die Benachrichtigungsadresse des Arbeitsbereichs.
Repositorys hinzufügen
Wähle auf GitHub Only select repositories und dann die Repositorys, die geprüft werden sollen. All repositories umfasst auch Repositorys, die später erstellt werden.
Um später Repositorys hinzuzufügen, wähle Repositorys hinzufügen auf der Seite Repositorys oder GitHub-Zugriff verwalten unter Arbeitsbereichseinstellungen → GitHub-Verbindung. Nur ein Inhaber des GitHub-Kontos kann Änderungen auf GitHub speichern. Alle anderen sehen Team fragen mit einer Anfrage, die sie kopieren und an einen Inhaber senden können.
Hinzugefügte Repositorys folgen den Standardeinstellungen des Arbeitsbereichs in den Prüfregeln. Eine Person sieht ein Repository und seine Prüfungen in HeyDeer, wenn sowohl sie als auch HeyDeer auf GitHub darauf zugreifen können. Zum Anfordern einer Prüfung ist Schreibzugriff nötig; siehe Befehle in PR-Kommentaren.
Berechtigungen
| Berechtigung | Zugriff | Wofür HeyDeer sie nutzt |
|---|---|---|
| Contents | Lesen und Schreiben | Code und Verlauf lesen, HeyDeers eigene Prüfungsunterhaltungen als erledigt markieren und Branches sowie Commits für Behebungen und @heydeer-Anfragen pushen. |
| Pull requests | Lesen und Schreiben | Pull Requests lesen, Prüfungen, Kommentare und Antworten veröffentlichen sowie Pull Requests öffnen, aktualisieren und mergen, um die du bittest. |
| Workflows | Lesen und Schreiben | GitHub-Actions-Workflow-Dateien aktualisieren, wenn eine Behebung oder Anfrage sie ändert. |
| Checks | Lesen und Schreiben | Den Check HeyDeer Review anzeigen und Anfragen über seine Schaltflächen empfangen. |
| Actions | Lesen | Logs fehlgeschlagener GitHub-Actions-Jobs lesen, damit Autopilot sie beheben kann. |
| Issues | Lesen und Schreiben | @heydeer-Erwähnungen und Befehle empfangen, sie mit Reaktionen bestätigen, zugehörige Issues lesen sowie Issues erstellen und aktualisieren, um die du bittest. |
| Metadata | Lesen | Grundlegende Repository-Informationen lesen und ermitteln, wer Schreibzugriff hat. |
| Members (Organisation) | Lesen | Mitglieder des Arbeitsbereichs auflisten und Mitglieds- und Team-Bedingungen in Filtern für automatische Prüfungen und unter Zugriff auf manuelle Prüfungen prüfen. |
| Email addresses (Konto) | Lesen | Deine bestätigte E-Mail-Adresse als Benachrichtigungsadresse vorschlagen. |
Wenn GitHub eine Berechtigung, die HeyDeer braucht, nicht erteilt hat, zeigt Arbeitsbereichseinstellungen → GitHub-Verbindung den Hinweis GitHub-Berechtigung erforderlich oder Weitere GitHub-Berechtigungen verfügbar. Ein Inhaber des GitHub-Kontos wählt Berechtigungsanfrage prüfen und akzeptiert sie auf GitHub.
Wie HeyDeer mit deinem Code und deinen Daten umgeht, erfährst du unter Sicherheit und Datenverarbeitung.
Wenn ein Konto oder Repository fehlt
Eine Organisation erscheint beim Verbinden erst, wenn HeyDeer auf ihr installiert ist. Um eine hinzuzufügen, wähle Auf GitHub installieren oder Auf einem anderen Konto installieren und wähle sie auf GitHub aus; bist du kein Inhaber, sendet GitHub den Inhabern eine Anfrage. Fehlt eine Organisation mit HeyDeer trotzdem, melde dich auf GitHub per SSO bei ihr an, öffne Dein Konto fehlt? und wähle Erneut bei GitHub anmelden.
Wenn eine Organisation noch keinen Arbeitsbereich hatte, als ein Inhaber deine Anfrage genehmigt hat, erstellt HeyDeer ihn mit dir als Admin.
Wenn HeyDeer Repository-Zugriff wiederherstellen anzeigt, kann dein GitHub-Konto die Repositorys nicht erreichen, auf die HeyDeer Zugriff erhalten hat. Wähle GitHub-Zugriff aktualisieren. Andere Fälle findest du unter Fehlerbehebung.
Wenn der GitHub-Zugriff von HeyDeer pausiert oder entfernt ist
Wenn HeyDeer auf GitHub ausgesetzt ist, zeigt Arbeitsbereichseinstellungen → GitHub-Verbindung den Hinweis GitHub-Zugriff ist pausiert, und Prüfungen können nicht ausgeführt werden. Ein Inhaber des GitHub-Kontos wählt GitHub-Zugriff fortsetzen.
Wenn HeyDeer deinstalliert wurde, zeigt es HeyDeer wurde aus GitHub entfernt. Ein Inhaber wählt HeyDeer erneut installieren; der Arbeitsbereich behält seine Einstellungen und seinen Prüfverlauf.