GitHub-Integration

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 und eingeschränkte Mitglieder können die GitHub-Integration nicht nutzen.

Verbindungstypen

Die verfügbaren Funktionen und Befehle hängen davon ab, welche Art von Verbindung du verwendest.

ClickUp-Befehle sind nur für persönliche Verbindungen verfügbar. Die Daten sind nicht mit Workspace-Verbindungen verknüpft. Wenn ein Benutzer eine Persönliche Verbindung aktiviert hat und einen GitHub-Befehl ausführt, wird ihm eine Liste mit Optionen angezeigt, z. B. Repository-Listen, die er in GitHub ansehen darf.

Verbindungstypen Beschreibung Features Befehle
Persönliche Verbindung Verbinde dein GitHub-Konto mit deinem ClickUp-Benutzerkonto für jeden Workspace, den du erstellt hast oder dem du beigetreten bist. Die Daten in deinem GitHub Konto sind über ClickUp für niemanden sonst zugänglich.

Persönliche Connected Search:

Durchsuche öffentliche und private Aufzeichnungen von deinem verbundenen GitHub-Konto. Niemand anderes kann Aufzeichnungen aus deinen persönlichen Verbindungen suchen.

GitHub-Link-Vorschauen

Mit der Link-Vorschau kannst du direkt in ClickUp eine synchronisierte Live-Visualisierung der Links sehen.

App-Bedienfeld in der Ansicht "Aufgabe":

Sieh dir GitHub Links von einem zentralen Ort in der Ansicht der Aufgabe an.

Öffne GitHub: Öffne GitHub in einem neuen Tab.

 

Erstelle ein neues GitHub-Problem: Erstelle ein neues GitHub Problem von ClickUp aus.

 

Neue GitHub Gist erstellen: Öffnet eine Registerkarte zur Seite für die Erstellung einer Gist.

 

Erstelle einen neuen GitHub-Zweig: Erstelle einen neuen GitHub-Zweig von ClickUp.

 

Neuen GitHub Pull Request erstellen: Die schnellste Art, einen GitHub Pull Request zu erstellen.

Workspace-Verbindung

Der Workspace-Eigentümer oder Administratoren können GitHub als Workspace-Verbindung aktivieren.

Verwende diese Verbindung, um allen den Zugriff auf die vernetzte Suche zu ermöglichen.

Workspace Connected Search:

Workspace Connected Search ermöglicht es allen Mitgliedern des Workspaces, sowohl öffentliche als auch private Datensätze vom verbundenen Konto zu suchen.

 

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:

  1. Der Workspace-Eigentümer oder Administrator erstellt eine Workspace GitHub Verbindung.
  2. Der Manager der mobilen App verbindet das app-mobile GitHub-Repo mit dem Space für mobile App-Entwicklung.
  3. Der Website-Manager verbindet das Website GitHub-Repo mit dem Marketing Website -Space.
  4. 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:

  1. GitHub verbinden.
  2. Hänge GitHub Repositories an deinen Workspace an.

    Repos sind notwendig, damit ClickUp automatisch Pull Requests mit den entsprechenden ClickUp-Aufgaben verknüpfen kann.

  3. Verknüpfe GitHub Repos mit ClickUp Spaces.
  4. Optional können Sie ein benutzerdefiniertes Branch-Namenformat festlegen.

Schritt 1: GitHub verbinden

Erfahre, wie du die GitHub-Integration verknüpfen kannst.

Schritt 2: Verknüpfen Sie GitHub-Repositorys mit Ihrem Workspace

Nur der Eigentümer der Verbindung kann Repositorys hinzufügen. 

Durch das Anhängen eines Repos erhalten ClickUp Benutzer keinen Zugriff auf die Codebase deines Repos.

Ein Repo zu einem Workspace hinzufügen:

  1. Im App-Center suche und wähle GitHub aus.
  2. Klicken Sie auf **Workspace-Einstellungen**.
  3. Neben Repositories zu ClickUp verbinden, klicken Sie auf Repo hinzufügen.
  4. Wählen Sie alle Repositories aus, die Sie hinzufügen möchten.

Wenn du die richtigen Repos nicht siehst, stelle sicher, dass du mit dem richtigen Konto angemeldet bist. Ein Workspace-Eigentümer oder Administrator muss jedes Repository auswählen, um es zu verbinden. Verknüpfte Repositories können im App-Center eingesehen werden.

Schritt 3: Verknüpfen Sie GitHub-Repositories mit ClickUp-Spaces

Nachdem Repos zu deinem Workspace hinzugefügt wurden, kann ein Administrator jedes Repo einem oder mehreren Spaces hinzufügen. Jeder ClickUp Space kann mehrere Repositorys hinzufügen.

Sie können jederzeit Repos aus Spaces hinzufügen oder entfernen.

Um ein Repository mit einem Space zu verknüpfen:

  1. Öffnen Sie GitHub im App-Center.
  2. Klicken Sie auf **Workspace-Einstellungen**.
  3. Klicken Sie auf den Namen des Repos, das Sie verknüpfen möchten.
  4. Klicken Sie auf + Space hinzufügen.
  5. 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:

  1. Klicken Sie auf **Workspace-Einstellungen**.
  2. Gib unter Automatisch generierter Name des Bereichs dein bevorzugtes Format für den Namen des Bereichs ein.
  3. Klicke auf Speichern.

Screenshot von jemandem, der einen benutzerdefinierten automatisch generierten Branch-Namen erstellt.

Durchsuchen Sie GitHub-Dateien mit der Connected Search

Verwende Workspace Connected Search, um allen Mitgliedern des Workspace die Suche nach öffentlichen Dateien aus den von dir hinzugefügten Repositorys zu ermöglichen.

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:

  1. Öffne eine Aufgabe und klicke 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.

  2. Klicke in der unteren rechten Ecke auf GitHub-Link hinzufügen.
    Screenshot des Modals zum Hinzufügen eines GitHub-Links.
  3. Fügen Sie einen Link ein.
  4. Klicke in der unteren rechten Ecke auf Hinzufügen.

Aktivität bei ClickUp Aufgaben

Der Aktivitätsfeed der Aufgabe fasst manchmal ähnliche Aktivitäten zusammen, um sicherzustellen, dass du die wichtigsten Details siehst.

Du kannst die folgenden Aktionen durchführen, um GitHub-Aktivitäten zu finden:

  • Klicke auf Mehr Updates, um versteckte Aktivitäten anzuzeigen.
  • Wenn ein Bereich zusammengeführt wird, werden Commits als einzelnes Aktivitätselement im Aktivitätsfeed der Aufgabe angezeigt.
    • Klicke auf den Link zu allen Commits, um ein modales Fenster zu öffnen.
    • Klicke auf ein einzelnes Commit, um es in GitHub zu öffnen.
  • Filtere die Aktivität der Aufgabe nach Git-Elementen.
     

Screenshot von jemandem, der die Aktivität einer Aufgabe nach Git-Elementen filtert.

Fehlende Aktivität 

Wenn du bestimmte Aktivitäten nicht finden kannst, stelle sicher, dass du die ClickUp-Aufgaben-ID korrekt verwendest, um Aktivitäten in GitHub zu verknüpfen. Du kannst eine dieser drei Optionen verwenden, um deine ClickUp-Aufgaben in Commits, Branch-Namen und Pull-Requests zu referenzieren:

#{task_id}

CU-{task_id}

{custom_task_id}

Zum Beispiel:

#1abc2de

CU-1abc2de

prefix-1

Du kannst ClickUp Aufgaben manuell verknüpfen mit GitHub Commits, Bereichen und Pull Requests direkt aus der ClickUp Aufgabe.

GitHub-Link-Vorschauen

Wenn du einen GitHub-Link in eine ClickUp-Aufgabe, Chat oder Dokument einfügst, hast du die Möglichkeit, ihn als Vorschau, Erwähnung oder URL einzufügen.

Screenshot von jemandem, der einen Link in einen Aufgabenkommentar einfügt.png

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:

  1. Ö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.
  2. In der unteren rechten Ecke klicken Sie auf GitHub-Link hinzufügen.
  3. Wählen Sie eine der folgenden Optionen:
    • Neues GitHub-Problem
    • Neuer GitHub-Branch
    • Neuer GitHub Pull Request
  4. Benenne das Problem, den Bereich oder den Pull Request.
  5. Wählen Sie ein Repository aus und füllen Sie die Informationen aus. Fügen Sie einen Quell- und Zielbereich hinzu, falls zutreffend.
    Screenshot von jemandem, der ein neues GitHub-Problem erstellt.
  6. 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.

Screenshot des GitHub-Tabs in einer Aufgabe, nachdem jemand einen Branch und ein Issue aus ClickUp hinzugefügt hat.

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:

  1. Füge die ClickUp Aufgaben-ID in einem beliebigen Teil der Commit- oder Pull Request-Nachricht hinzu.
  2. [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.

Wenn du dem Workspace als Gast beigetreten bist, kannst du die GitHub-Integration nicht nutzen. Kontaktiere deinen Workspace-Eigentümer oder Administrator, um ein Upgrade auf ein Workspace-Mitglied zu beantragen.

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:

  1. Suchen und wählen Sie GitHub.
  2. Klicken Sie auf den Persönlich -Reiter.
  3. Klicken Sie neben Eine persönliche Verbindung herstellen auf Verbinden.
  4. Melden Sie sich bei GitHub an und autorisieren Sie ClickUp.

Pull Requests in der Listen- oder Tabellenansicht anzeigen

Füge die Spalte Pull Requests zu jeder Listenansicht oder Tabelle hinzu, um deine GitHub Pull Requests schnell anzufordern.

Verbindungsprobleme

Manchmal ist das falsche GitHub-Konto verknüpft oder es gibt ein Problem mit der Verbindung. In diesem Szenario kannst du versuchen, deine Repositories oder das gesamte Konto zu trennen und erneut zu verbinden.

Diese Aktionen beeinträchtigen nicht die Fähigkeit anderer, auf Repos über ihr GitHub-Konto durch GitHub zuzugreifen.

Um ein Repository zu trennen:

  1. Wähle im App-Center GitHub aus.
  2. Klicke in der oberen rechten Ecke auf Workspace-Einstellungen.
  3. Unter Repositories klicke auf das Menü ellipsis ... rechts vom Repository.
  4. Klicke auf Von ClickUp löschen.

Der Abschnitt unten enthält Anweisungen zum Trennen deines gesamten Kontos.

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:

  1. Suchen und wählen Sie GitHub.
  2. Wähle die Registerkarte Workspace aus.

    Nur Eigentümer und Administratoren können Workspace-Verbindungen trennen.

  3. Klicken Sie neben Verbunden auf das Menü ellipsis ....
  4. Wählen Sie Trennen.
  5. Zum Bestätigen klicken Sie auf Trennen.

OAuth-Bereiche

Unten findest du eine Tabelle aller OAuth-Bereiche für die GitHub-Integration, damit du informierte Sicherheits- und Compliance-Entscheidungen treffen kannst, bevor du sie in deinem Workspace aktivierst.

Umfang Beschreibung
read:user Identifiziert Benutzer und Basisprofil
Repo Ermöglicht das Indizieren von Repo-Inhalten, das Entfalten von Links und das Ausführen von Repo-Befehlen
admin:repo_hook Ermöglicht das Erstellen und Verwalten von Webhooks für Synchronisationsfunktionen
Projekt Wenn aktiviert, ermöglicht den Zugriff auf Projekte und Board-Daten
read:org Wenn aktiviert, ermöglicht den Zugriff auf Projekte und Board-Daten