Verknüpfen Sie Spaces direkt mit GitHub-Repositories, um immer zu wissen, welche Arbeit damit zusammenhängt.
Workspace-Eigentümer und Administratoren können Spaces mit ihren Repos verbinden, so dass Mitglieder ihre Github-Arbeiten zu Aufgaben hinzufügen können.
Aufgaben in Spaces mit einem verbundenen Repository können mit Commits, Bereichen und Pull Requests verknüpft werden.
Was du wissen musst
- Die GitHub-Integration ist in jedem ClickUp-Plan verfügbar.
- Nur Repository-Administratoren können GitHub Repositories zu ClickUp hinzufügen. Einmal hinzugefügt, können Workspace-Administratoren diese Repositories zu ClickUp Spaces hinzufügen!
- Nur Workspace-Eigentümer und Administratoren können die Einstellungen für den Workspace im App Center aktualisieren.
- Nur Eigentümer und Administratoren eines Workspaces können Repositorys zu Spaces hinzufügen und verknüpfen.
- Nur Eigentümer und Administratoren eines Workspaces können Workspace-Verbindungen erstellen. Es sind mehrere Workspace Verbindungen erlaubt.
- Mitglieder und darüber hinaus können persönliche Verbindungen erstellen.
- Gäste können die GitHub-Integration nicht nutzen.
-
Die Workspace-verbundene Suche ist im Business-Plan und höher verfügbar.
- Die persönliche Connected Search ist für die GitHub-Integration nicht verfügbar.
Beispiel aus der realen Welt
Das Engineering-Team für Ihre mobile App und das Website-Entwicklungsteam arbeiten in verschiedenen Repos und separaten Spaces, innerhalb derselben GitHub-Organisation und des ClickUp-Workspaces.
Um mit der Integration zu beginnen:
- Der Workspace-Eigentümer oder Administrator erstellt eine Workspace GitHub Verbindung.
- Der Manager der mobilen App verbindet das app-mobile GitHub-Repo mit dem Space für mobile App-Entwicklung.
- Der Website-Manager verbindet das Website GitHub-Repo mit dem Marketing Website -Space.
- Aufgaben in der mobilen App-Entwicklungs- und Marketing Website Spaces zeigen jetzt das GitHub-Symbol an, damit beide Teams ihre Aufgaben mit GitHub Commits, Bereichen und Pull Requests verknüpfen können.
Integration einrichten
Es gibt vier Schritte, um die GitHub-Integration in ClickUp einzurichten:
- GitHub verbinden.
- Hänge GitHub Repositories an deinen Workspace an.
- Verknüpfe GitHub Repos mit ClickUp Spaces.
- Optional können Sie ein benutzerdefiniertes Branch-Namenformat festlegen.
Schritt 1: GitHub verbinden
Du musst ein Workspace-Eigentümer oder Administrator sein, um eine Workspace-Verbindung für GitHub einzurichten.
Sie können eine GitHub-Verbindung vom App-Center oder Command-Center einrichten.
Über das App Center:
- Suchen und wählen Sie GitHub aus.
- Klicken Sie auf die Registerkarte Workspace.
Sie können auch eine persönliche Verbindung einrichten, um Pull Requests und Bereiche von ClickUp aus zu erstellen. Persönliche Verbindungen können auch verwendet werden, um bestehende Pull Requests, Bereiche und Commits direkt aus ClickUp-Aufgaben zu verknüpfen.
- Klicke auf Verbinden.
- Melden Sie sich bei Ihrem GitHub-Konto an, um den Zugriff zu autorisieren.
Über das Command-Center:
- Klicken Sie unter der Suchleiste auf Apps.
- Klicken Sie unter GitHub auf Verbinden.
- Unter Workspace-Verbindungen klicken Sie auf Verbinden.
- Melden Sie sich bei Ihrem GitHub-Konto an, um den Zugriff zu autorisieren.
Schritt 2: Verknüpfen Sie GitHub-Repositorys mit Ihrem Workspace
Workspace-Eigentümer und Administratoren können auswählen, welche GitHub-Repositorys sie mit ihrem ClickUp-Workspace verknüpfen möchten. Der Eigentümer oder Administrator muss ebenfalls ein Administrator des GitHub-Repositorys sein.
Durch das Anhängen eines Repos erhalten ClickUp Benutzer keinen Zugriff auf die Codebase deines Repos.
Ein Repo zu einem Workspace hinzufügen:
- Öffnen Sie GitHub im App-Center.
- Klicken Sie auf **Workspace-Einstellungen**.
- Neben Repositories zu ClickUp verbinden, klicken Sie auf Repo hinzufügen.
- Wählen Sie alle Repositories aus, die Sie hinzufügen möchten.
Wenn du nicht die richtigen Repos siehst, hast du dich vielleicht mit dem falschen GitHub Konto angemeldet.
Schritt 3: Verknüpfen Sie GitHub-Repositories mit ClickUp-Spaces
Nachdem Sie Repos zu Ihrem Workspace hinzugefügt haben, können Sie jedes Repo einem oder mehreren Spaces hinzufügen. Jeder ClickUp-Space kann mehrere Repositorys hinzugefügt haben.
Sie können jederzeit Repos aus Spaces hinzufügen oder entfernen.
Um ein Repository mit einem Space zu verknüpfen:
- Öffnen Sie GitHub im App-Center.
- Klicken Sie auf **Workspace-Einstellungen**.
- Klicken Sie auf den Namen des Repos, das Sie verknüpfen möchten.
- Klicken Sie auf + Space hinzufügen.
- Wiederholen Sie dies für zusätzliche Spaces, die Sie verknüpfen möchten.
Schritt 4: Legen Sie Ihr Branch-Namen-Format fest
Wenn Ihre Organisation ein spezifisches Format für Branch-Namen verwendet, können Sie dies auf der GitHub-Seite im App-Center einstellen. Wenn Personen Branches aus ClickUp-Aufgaben erstellen, wird dieses Format verwendet.
Das Standardformat lautet: :taskId:_:taskName:_:username:
Zum Beispiel: CU-ae27de_Auto-generated-naming_John-smith
Die verfügbaren Optionen werden in der folgenden Tabelle angezeigt:
Wert | Beschreibung |
:username: | Der Benutzername des ClickUp-Benutzerkontos, das den Bereich erstellt hat. Leerzeichen werden durch einen Bindestrich ersetzt. |
:taskId: | Die ID der ClickUp Aufgabe, in der der Zweig erstellt wird. Enthält das erforderliche Präfix. |
:taskName: | Der Name der Aufgabe, bei der der Zweig erstellt wird. Leerzeichen werden durch einen Bindestrich ersetzt. |
So stellst du dein Standard Format für den Namen von GitHub im App Center ein:
- Klicken Sie auf **Workspace-Einstellungen**.
- Gib unter Automatisch generierter Name des Bereichs dein bevorzugtes Format für den Namen des Bereichs ein.
- Klicke auf Speichern.
Durchsuchen Sie GitHub-Dateien mit der Connected Search
Bei Verwendung einer Workspace-Verbindung im Business-Plan und höher können Sie die Workspace Connected Search nutzen, um allen Workspace-Mitgliedern zu ermöglichen, nach allen öffentlichen Dateien aus den hinzugefügten Repositories zu suchen. Private Dateien können nicht durchsucht werden.
Über das App-Center:
- Suchen und wählen Sie GitHub aus.
- Klicken Sie auf den Tab Workspace.
- Klicke auf den Schalter neben Workspace Connected Search.
- Neben Ihrer Workspace-Verbindung klicken Sie auf Speichern.
- GitHub-Dateien in den hinzugefügten Repositories werden angezeigt, wenn Sie Ihren Workspace durchsuchen.
Pin GitHub an Command-Center
Filtern Sie Suchergebnisse zu GitHub-Dateien, indem Sie GitHub im Command-Center anheften.
Aufgaben aus GitHub verknüpfen
ClickUp verknüpft automatisch neue GitHub-Aktivitäten mit Aufgaben, wenn Sie eine gültige ClickUp Aufgaben-ID in einem Teil des Titels der Pull-Anfrage, der Beschreibung der Pull-Anfrage, des Branch-Namens oder der Commit-Nachricht einfügen.
Wenn eine ClickUp-Aufgaben-ID in einem Pull Request enthalten ist, wird ein Kommentar mit einem Link zur ClickUp-Aufgabe im Pull Request gepostet. Ein Link wird nicht angezeigt, wenn du einen Pull Request manuell in eine ClickUp Aufgabe einfügst.
Der Kommentar wird über das GitHub-Konto der Person veröffentlicht, die das Repository und die Space-Zuordnung eingerichtet hat.
Die Aufgaben-ID muss eines dieser Formate verwenden:
#{task_id}
CU-{task_id}
{custom_task_id}
#{custom_task_id}
Zum Beispiel:
#1abc2de
CU-1abc2de
eng-123
#eng-123
Aufgaben aus ClickUp verlinken
Du kannst ClickUp Aufgaben auch manuell mit GitHub Commits, Branches und Pull Requests der ClickUp Aufgabe verknüpfen. Stelle sicher, dass sich die Aufgabe in einem Space befindet, der mit einem Repo verknüpft ist.
Um eine Aufgabe zu verknüpfen:
- Öffnen Sie eine Aufgabe und klicken Sie auf das GitHub -Symbol.
Auf der rechten Seite siehst du die vorgeschlagenen Namen der Bereiche und die Commit-Nachrichten, die du in deine Zwischenablage kopieren kannst. Sie können auch die Aufgaben-ID von hier kopieren.
-
Klicke in der unteren rechten Ecke auf GitHub-Link hinzufügen.
- Fügen Sie einen Link ein.
- Klicke in der unteren rechten Ecke auf Hinzufügen.
Erstellen Sie GitHub-Probleme, Branches und Pull Requests aus ClickUp
Sie können auch direkt aus Aufgaben neue Probleme, Branches und Pull Requests erstellen. Stellen Sie sicher, dass die Aufgabe in einem Space liegt, der mit einem Repo verknüpft ist.
Um ein Problem, einen Bereich oder einen Pull-Request zu erstellen:
- Öffnen Sie eine Aufgabe und klicken Sie auf das GitHub -Symbol.
Rechts sehen Sie vorgeschlagene Branch-Namen und Commit-Nachrichten, die Sie in Ihre Zwischenablage kopieren können. Sie können auch die Aufgaben-ID von hier kopieren. - In der unteren rechten Ecke klicken Sie auf GitHub-Link hinzufügen.
- Wählen Sie eine der folgenden Optionen:
- Neues GitHub-Problem
- Neuer GitHub-Branch
- Neuer GitHub Pull Request
- Benenne das Problem, den Bereich oder den Pull Request.
- Wählen Sie ein Repository aus und füllen Sie die Informationen aus. Fügen Sie einen Quell- und Zielbereich hinzu, falls zutreffend.
- Klicke auf Erstellen.
GitHub-Panel in der Aufgabenansicht
Nachdem du deinen ersten GitHub-Link in einer Aufgabenbeschreibung oder einem Kommentar eingefügt hast, erscheint ein neues GitHub -Symbol in der Seitenleiste rechts in deiner Aufgabenansicht. Du kannst jederzeit auf dieses Symbol klicken, um alle in der Aufgabe geposteten GitHub-Links zu sehen.
Die GitHub-Aufgabenaktivität verwendet den ClickUp-Benutzernamen der Person oder ihren GitHub-Benutzernamen, falls sie kein ClickUp-Konto besitzt.
Aktualisiere Aufgabenstatus über GitHub
Sie können den Status einer ClickUp-Aufgabe aktualisieren, wenn Sie ein Commit verlinken, ein Commit pushen oder einen Pull-Request erstellen. ClickUp erfasst automatisch neue Aktivitäten in GitHub und ordnet diese Aufgaben zu, wenn Sie eine gültige Aufgaben-ID in einem Teil des Titels des Pull Requests, der Beschreibung des Pull Requests, des Branch-Namens oder der Commit-Nachricht einfügen.
Die Aufgaben-ID muss eines dieser Formate verwenden:
#{task_id}[Status]
CU-{task_id}[status]
{custom_task_id}[Status]
#{custom_task_id}[Status]
So aktualisierst du den Status einer Aufgabe:
- Füge die ClickUp Aufgaben-ID in einem beliebigen Teil der Commit- oder Pull Request-Nachricht hinzu.
- [Status der Aufgabe aktualisiert]
Zum Beispiel: #ud5b[bereit]
Alle in dem Abschnitt Aufgaben von GitHub verlinken dieses Artikels aufgeführten Formate können verwendet werden. Um eine korrekte Formatierung zu gewährleisten, fügen Sie keinen Leerzeichen zwischen der Aufgaben-ID und den Statusinformationen hinzu.
Du kannst auch Aufgabenstatus über GitHub-Automatisierungen aktualisieren!
Verwalte GitHub Probleme, Bereiche, Pull Requests und Commits von ClickUp
Nachdem du Probleme, Bereiche, Pull Requests oder Commits verknüpft hast, werden sie auf der rechten Seite deiner Aufgabe angezeigt, wenn du auf das GitHub-Symbol klickst. Verwenden Sie das Menü Ellipse ..., um den Link zu kopieren oder das Element zu löschen.
Sobald Sie ein GitHub-Element verlinken, werden die folgenden Informationen in Ihrer ClickUp-Aufgabe angezeigt:
Informationen zum Problem
Nachdem ein Problem verknüpft wurde, können Sie die folgenden Details sehen:
- Die Person, die das Problem gemeldet hat, wird als Verfasser bezeichnet
- Zugewiesene Prüfer
- Link erstellt
- Repository
- Der Status des Problems.
- URL
Bereichsinformationen
Nachdem ein Bereich verknüpft wurde, können Sie die folgenden Details einsehen:
- Die Person, die den Bereich erstellt hat, bekannt als der Autor
- Link-Ersteller
- Repository
- URL
Informationen zu Pull Requests
Nachdem ein Pull Request verknüpft wurde, kannst du die folgenden Details sehen:
- Die Person, die den Pull Request angefordert hat, bekannt als der Verfasser
- Zugewiesene Prüfer
- Mitarbeiter
- Zeilenänderungen
- Link erstellt
- Repository
- Bereich Quelle
- Zielbereich
- Der Pull-Request-Status
- URL
Commit-Informationen
Nachdem ein Commit verknüpft wurde, können Sie die folgenden Details sehen:
- Die Person, die das Commit erstellt hat, wird als Autor bezeichnet
- Geänderte Dateien
- Zeilenänderungen
- Link erstellt
- Repository
- URL
Fügen Sie Ihr GitHub-Konto zu ClickUp hinzu
Workspace-Mitglieder können ihre GitHub-Konten im Voraus oder beim Erstellen eines Branches oder Pull Requests mit ihrem ClickUp-Konto verknüpfen.
Um Ihr GitHub-Konto vom App-Center aus hinzuzufügen:
- Suchen und wählen Sie GitHub.
- Klicken Sie auf den Persönlich -Reiter.
- Klicken Sie neben Eine persönliche Verbindung herstellen auf Verbinden.
- Melden Sie sich bei GitHub an und autorisieren Sie ClickUp.
Trenne die GitHub-Integration
Wenn Sie keinen Zugriff mehr auf GitHub-Dateien in ClickUp benötigen, können Sie die Integration im App-Center trennen:
- Suchen und wählen Sie GitHub.
- Wähle die Registerkarte " Arbeitsbereich" aus.
Nur Eigentümer und Administratoren können Workspace-Verbindungen trennen.
- Klicken Sie neben Verbunden auf das Menü ellipsis ....
- Wählen Sie Trennen.
- Zum Bestätigen klicken Sie auf Trennen.