Dokumentation

GitHub

Verbinden Sie GitHub mit der App oder einem persönlichen Zugriffstoken und erfahren Sie, welche Berechtigungen jeweils gewährt werden.

GitHub verbindet sich entweder über das Coroid GitHub App oder ein persönliches Zugriffstoken. Konfigurieren Sie es unter Einstellungen → Verbindungen → Quellcode-Verwaltung.

App oder Token

Die App ist die bevorzugte Option. Sie gewährt Zugriff pro Repository statt pro Benutzer, funktioniert weiter, wenn die Person, die sie eingerichtet hat, das Unternehmen verlässt, und empfängt Webhook-Ereignisse ohne Polling.

Verwenden Sie ein Token, wenn die Installation der App eine Organisationsadministratorfreigabe erfordert, die Sie nicht erhalten können.

GitHub AppPersönliches Zugriffstoken
ZugriffsbereichPro RepositoryAlles, was der Benutzer sehen kann
Bleibt auch nach dem Ausscheiden des Installateurs aktivJaNein
Webhook-EreignisseJaPolling
ZuordnungDie AppDer Token-Inhaber

Installation der App

Wählen Sie GitHub unter Einstellungen → Verbindungen → Quellcode-Verwaltung aus und folgen Sie dem Installationsprozess. GitHub fragt nach den zu gewährenden Repositories; diese Einstellung können Sie später in den Einstellungen von GitHub ändern.

Falls ein Repository beim Erstellen eines Projekts nicht angezeigt wird, wurde der App fast sicher nicht das jeweilige Repository zugewiesen – das ist die häufigste Ursache.

Verwendung eines Tokens

Erstellen Sie ein klassisches Token mit dem repo Bereich oder ein feingranulares Token mit Les- und Schreibrechten für Inhalte sowie Pull Requests, und fügen Sie es anschließend in die Einstellungen zur Versionsverwaltung ein.

Tokens werden ruhend verschlüsselt gespeichert, vom API nie zurückgegeben und nie in Einstellungs-Exporte aufgenommen.

GitHub Issues

Dieselbe Verbindung ermöglicht das Importieren von Issues als Arbeitsaufgaben. Siehe Arbeitsaufgaben importieren.

Ereignisse, die zu Arbeitsaufgaben werden

Mit der App kann eine Ereignisautomatisierung ein pull request, ein neues Issue oder einen Kommentar erstellen, der Coroid in Qualification erwähnt. Siehe Trigger und Zielorte.

Qualifizierte Arbeitsaufgaben aus diesen Ereignissen werden nur dann automatisch gestartet, wenn ihr Ersteller über Schreib-, Bearbeitungs- oder Administratorrechte für das Repository verfügt. Coroid fragt bei jedem Ereignis GitHub um Bestätigung. Bei einem pull request ist der Ersteller die Person, die es geöffnet hat, nicht die Person, die es gekennzeichnet oder zusammengeführt hat. Arbeitsaufgaben von anderen Personen werden erstellt und warten darauf, dass jemand sie startet. Ein Kommentar, der Coroid erwähnt, zählt nur, wenn sein Autor über Schreibrechte verfügt.

Pull Requests überprüfen

Mit der App prüft und überprüft Coroid Pull Requests, die von Menschen und anderen Tools geöffnet werden – nicht nur die eigenen Pull Requests von Coroid. Die Coroid Qualitätskontrolle führt die Prüfungen des Projekts durch und gibt den Coroid Qualitätskontrolle-Check aus. Die Coroid Rezension gibt eine Rezension mit Kommentaren zu den betroffenen Zeilen aus und einen Check namens Coroid Rezension. Beide Einstellungen finden Sie unter Qualitätskontrolle, im Bereich Pull Requests. Siehe Pull Requests.

Was Coroid in Ihrem Repository tut

  • liest den Code, um ihn zu verstehen und zu ändern
  • erstellt pro Aufgabe einen Branch
  • pusht diesen Branch und öffnet einen pull request gegen Ihren Basisbranch

Es committet niemals direkt in Ihren Standardbranch oder führt ein Zusammenführen selbstständig durch. Ein Zusammenführen erfolgt nur, wenn eine Person den pull request in GitHub zusammenführt oder auf Genehmigen & zusammenführen in Coroid klickt.

Ein Projekt, das auf Nur lokal eingestellt ist, führt nur den ersten Schritt aus und nichts weiter: Coroid liest und zieht Daten, und speichert Branches, Rezensionen und Prüfungen innerhalb von Coroid. Es pusht nicht, öffnet keine Pull Requests oder gibt Kommentare ab, noch führt es Prüfläufe aus – selbst wenn die App oder das Token dies erlauben würden. Siehe Synchronisiert oder nur lokal.

Ihre Branch-Schutzregeln, erforderlichen Prüfungen und Rezensionsregeln bleiben unverändert. Genehmigen & zusammenführen führt das Zusammenführen ebenfalls über pull request durch, sodass dieselben Regeln darüber entscheiden, ob es erfolgreich ist. Siehe Zusammenführen.