Intégration de GitHub

Associez directement Espaces à GitHub référentiels afin de toujours savoir à quoi s’applique le travail.

propriétaire de l’environnement de travail et administrateur peuvent connecter Espaces à leur référentiel, ce qui permet aux membres d’ajouter leur GitHub travail à tâche.

Les tâches dans les Espaces avec un référentiel connecté peuvent être liées à des validations, des branches et des demandes de tirage.

Ce dont vous aurez besoin

  • L'intégration GitHub est disponible sur chaque forfait ClickUp.
  • Seuls les administrateurs de référentiels peuvent ajouter des référentiels GitHub à ClickUp. Une fois ajoutés, les administrateurs de l'environnement de travail peuvent intégrer ces référentiels aux Espaces ClickUp !
  • Seuls les propriétaires et administrateurs de l'environnement de travail peuvent mettre à jour les paramètres de l'environnement de travail dans le Centre d'applications.
  • Seuls les propriétaires et les administrateurs de l'environnement de travail peuvent ajouter et lier des référentiels aux Espaces.
  • Seuls les propriétaires d'environnement de travail et les administrateurs peuvent créer des connexions d'environnement de travail. Plusieurs connexions à des environnements de travail sont autorisées.
  • membre et supérieur peuvent créer une connexion personnelle.
  • Les invités ne peuvent pas utiliser l'intégration GitHub.

Types de connexion

Les fonctionnalités et commandes disponibles dépendent du type de connexion utilisé.

Les commandes ClickUp sont disponibles uniquement pour les Connexions Personnelles. Les données ne sont pas liées aux Connexions de l'environnement de travail. Lorsqu'un utilisateur a activé sa connexion personnelle et qu'il exécute une commande GitHub, il voit apparaître une liste d'options, comme des listes de référentiels, qu'il est autorisé à consulter sur GitHub.

Type de connexion Description Fonctionnalités Commandes
Connexion personnelle Connectez votre compte GitHub à votre compte utilisateur ClickUp pour chaque environnement de travail que vous avez créé ou rejoint. Les données de ton compte GitHub ne seront accessibles à personne d'autre via ClickUp.

Recherche Personnelle Connectée :

Recherchez des enregistrements publics et privés depuis votre compte GitHub connecté. Personne d'autre ne peut rechercher des enregistrements depuis vos connexions personnelles.

Aperçus des liens GitHub

Les aperçus des liens te permettent de voir des visualisations synchronisées et en direct des liens directement dans ClickUp.

Panneau des applications dans la vue des tâches :

Affichez les liens GitHub depuis un emplacement central dans la vue Tâche.

Ouvre GitHub: ouvre GitHub dans un nouvel onglet.

 

Créer un nouveau numéro GitHub : crée un nouveau numéro GitHub depuis ClickUp.

 

Créer un nouveau Gist GitHub: Ouvre un onglet vers la page de création de Gist.

 

Créer une nouvelle branche GitHub: Créez une nouvelle branche GitHub depuis ClickUp.

 

Créer une nouvelle demande de tirage GitHub: Le moyen le plus rapide de créer une demande de tirage sur GitHub.

Connexion de l’environnement de travail

Le propriétaire de l'environnement de travail ou les administrateurs peuvent activer GitHub comme connexion pour l'environnement de travail.

Utilise cette connexion pour permettre à tout le monde d'accéder à la recherche connectée.

Recherche connectée dans l’environnement de travail

Permettez à tous les membres de l’environnement de travail de faire des recherches dans des fichiers publics à partir du compte que vous connectez. Les dossiers privés ne peuvent pas être recherchés.

 

Exemple concret

L'équipe d'ingénierie de votre application mobile et l'équipe de développement de site web travaillent dans des référentiels et des espaces séparés, au sein de la même organisation GitHub et de l'environnement de travail ClickUp.

Pour commencer avec l'intégration :

  1. Le propriétaire ou l'administrateur de l'environnement de travail crée une connexion GitHub de l'environnement de travail.
  2. Le gestionnaire d'application mobile relie le référentiel app-mobile GitHub à l'espace développement d'applications mobiles.
  3. Le gestionnaire de site web relie le référentiel GitHub du site web à l'espace site web marketing.
  4. Les tâches dans les espaces de développement d'applications mobiles et de site web marketing affichent désormais l'icône GitHub, permettant aux équipes de lier leurs tâches aux validations, branches et demandes de tirage GitHub.

Configurer l’intégration

Il y a quatre étapes pour configurer l'intégration de GitHub dans ClickUp :

  1. Connectez GitHub.
  2. Associez des référentiels GitHub à votre environnement de travail.

    Les référentiels sont nécessaires pour que ClickUp puisse automatiquement lier les demandes de tirage à leurs tâches ClickUp respectives.

  3. Lien GitHub référentiel vers ClickUp Espaces.
  4. Vous pouvez définir un format de nom de branche personnalisé.

Étape 1 : Connectez- GitHub

Apprenez comment connecter l'intégration GitHub.

Étape 2 : Attachez les référentiels GitHub à votre environnement de travail

Seul le propriétaire de la connexion peut ajouter des référentiels. 

Attacher un référentiel ne donne pas aux utilisateurs de ClickUp accès à la base de code de votre référentiel.

Pour ajouter un référentiel à un environnement de travail :

  1. Dans le Centre d'applications, recherchez et sélectionnez GitHub.
  2. Cliquez sur **Paramètres de l’environnement de travail**.
  3. À côté de Connecter des référentiels à ClickUp, cliquez sur Ajouter un référentiel.
  4. Sélectionnez tous les référentiels que vous souhaitez ajouter.

Si vous ne voyez pas les bons référentiels, assurez-vous d'être connecté au bon compte. Un propriétaire ou un administrateur de l'environnement de travail doit sélectionner chaque référentiel à connecter. Les référentiels liés peuvent être consultés dans le Centre d'applications.

Étape 3 : Lier les répertoires GitHub aux espaces ClickUp

Après avoir ajouté des référentiels à votre environnement de travail, un administrateur peut ajouter chaque référentiel à un ou plusieurs Espaces. Chaque espace ClickUp peut avoir plusieurs référentiels ajoutés.

Vous pouvez ajouter ou retirer des référentiels des Espaces à tout moment.

Pour lier un référentiel à un Espace :

  1. Ouvrez GitHub dans le Centre d'applications.
  2. Cliquez sur **Paramètres de l’environnement de travail**.
  3. Cliquez sur le nom du référentiel que vous souhaitez lier.
  4. Cliquez sur + Ajouter un espace.
  5. Répétez pour les autres espaces que vous souhaitez lier.

Étape 4 : Définissez le format de nom de votre branche

Si votre organisation utilise un format spécifique pour les noms de branches, vous pouvez le définir depuis la page GitHub dans le Centre d'applications. Lorsque les utilisateurs créent des branches à partir de tâches ClickUp, elles utiliseront ce format.

Le format par défaut est : :taskId:_:taskName:_:username:

Par exemple: CU-ae27de_Auto-generated-naming_John-smith

Les options disponibles sont indiquées dans le tableau suivant :

Valeur Description
:username: Le nom d'utilisateur du compte ClickUp qui a créé la branche. Les espaces sont remplacés par un tiret.
:taskId: L’identifiant de la tâche ClickUp où la branche est créée. Comprend le préfixe requis.
:taskName : Le nom de la tâche où la branche est créée. Les espaces sont remplacés par un tiret.

Pour définir votre format de nom par défaut depuis GitHub dans le Centre d'applications :

  1. Cliquez sur **Paramètres de l’environnement de travail**.
  2. Sous Nom de branche auto-généré, saisissez le format de nom de branche que vous préférez.
  3. Cliquez sur Enregistrer.

Capture d'écran montrant la création d'un nom de branche généré automatiquement.

Recherchez des fichiers sur GitHub en utilisant la Recherche Connectée

Utilisez la Recherche Connectée de l'environnement de travail pour permettre à tous les membres de l'environnement de travail de rechercher des fichiers publics dans les référentiels que vous ajoutez. Les fichiers privés ne peuvent pas être recherchés.

Lier des tâches depuis GitHub

ClickUp associe automatiquement la nouvelle activité GitHub aux tâches si vous incluez un identifiant de tâche valide de ClickUp dans n'importe quelle partie du titre de la demande de tirage, de la description de la demande de tirage, du nom de la branche ou du message de validation.

Lorsqu’une tâche ClickUp identifiant est incluse dans une demande de tirage, un commentaire avec un lien vers la tâche ClickUp sera publié dans la demande de tirage. Un lien ne s’affichera pas lors du collage manuel d’une demande de tirage dans une tâche ClickUp.

Le commentaire sera posté à l’aide du compte GitHub de la personne qui a mis en place le référentiel et l’espace mapping.

L'identifiant de la tâche doit être formaté en utilisant l'une de ces options :

#{task_id}

CU-{task_id}

{custom_task_id}

#{custom_task_id}

Par exemple :

#1abc2de

CU-1abc2de

eng-123

#eng-123

Lier la tâche à partir de ClickUp

Vous pouvez également lier manuellement les tâches ClickUp avec les validations, branches et demandes de tirage GitHub directement depuis la tâche ClickUp. Assurez-vous que la tâche se trouve dans un espace lié à un référentiel.

Pour lier une tâche :

  1. Ouvrez une tâche et cliquez sur l'icône GitHub.

    Sur la droite, vous trouverez des noms de branches suggérés et des messages de validation que vous pouvez copier dans votre bloc-notes. Vous pouvez également copier l'identifiant de la tâche ici.

  2. Dans le coin inférieur droit, cliquez sur Ajouter un lien GitHub.
    Capture d'écran du modal d'ajout de lien GitHub.
  3. Coller un lien.
  4. Dans le coin inférieur droit, cliquez sur Ajouter.

Activité de tâche ClickUp

Le fil d'activité des tâches peut parfois regrouper des éléments d'activité similaires pour vous montrer les détails les plus importants.

Vous pouvez prendre les actions suivantes pour localiser l'activité GitHub :

  • Cliquez sur Plus d'actualisations pour révéler les activités qui ont été masquées.
  • Lorsqu'une branche est fusionnée, les validations apparaissent comme un élément d'activité unique dans le fil d'activité de la tâche.
    • Cliquez sur le lien pour ouvrir tous les commits dans un modal.
    • Cliquez sur une validation individuelle pour l'ouvrir dans GitHub.
  • Filtrer l'activité des tâches par éléments Git.

Capture d'écran de quelqu'un filtrant l'activité d'une tâche par des éléments Git.

Activité manquante 

Si vous ne parvenez pas à localiser certaines activités, assurez-vous de bien référencer l'identifiant de tâche ClickUp pour lier l'activité dans GitHub. Vous pouvez utiliser l'une de ces trois options pour référencer vos tâches ClickUp dans les commits, les noms de branches et les demandes de tirage :

#{task_id}

CU-{task_id}

{custom_task_id}

Par exemple :

#1abc2de

CU-1abc2de

préfixe-1

Vous pouvez lier manuellement les tâches ClickUp avec les validations, les branches et les demandes de tirage de GitHub depuis la tâche ClickUp.

Aperçus des liens GitHub

Lorsque vous collez un lien GitHub dans une tâche ClickUp, Chat, ou Doc, vous verrez l'option de le coller comme aperçu, mention ou URL.

Capture d'écran de quelqu'un collant un lien dans un commentaire de tâche.png

Créez des problèmes, des branches et des demandes de tirage GitHub depuis ClickUp

Vous pouvez également créer de nouveaux problèmes, branches et demandes de tirage directement depuis les tâches. Assurez-vous que la tâche se trouve dans un espace lié à un référentiel.

Pour créer un problème, une branche ou une demande de tirage :

  1. Ouvrez une tâche et cliquez sur l'icône GitHub.
    À droite, vous trouverez des suggestions de noms de branches et de messages de validation que vous pouvez copier dans votre bloc-notes. Vous pouvez également copier l'identifiant de tâche depuis ici.
  2. Dans le coin inférieur droit, cliquez sur Ajouter un lien GitHub.
  3. Choisissez l'une des options suivantes :
    • Nouveau problème GitHub
    • Nouvelle branche GitHub
    • New GitHub Pull Request
  4. Nommez le problème, la branche ou la demande de tirage.
  5. Sélectionnez un référentiel et remplissez les informations. Ajoutez une branche source et une branche cible si applicable.
    Capture d'écran de quelqu'un créant un nouveau problème sur GitHub.
  6. Cliquez sur Créer.

Panneau GitHub dans la vue Tâche

Après avoir collé votre premier lien GitHub dans une description de tâche ou un commentaire, vous verrez une nouvelle icône GitHub dans la barre latérale droite de votre vue Tâche. Vous pouvez cliquer sur cette icône à tout moment pour voir chaque lien GitHub posté dans la tâche.

Capture d'écran de l'onglet GitHub dans une tâche après qu'un utilisateur a ajouté une branche et un problème depuis ClickUp.

L’activité de tâche GitHub utilise le nom d’utilisateur ClickUp de la personne ou son nom d’utilisateur GitHub si elle n’a pas de compte ClickUp.

Mettre à jour les statuts des tâches depuis GitHub

Vous pouvez mettre à jour le statut d'une tâche ClickUp lorsque vous liez une validation, poussez une validation ou créez une demande de tirage. ClickUp détecte automatiquement les nouvelles activités sur GitHub et les associe aux tâches si vous incluez un identifiant de tâche valide dans le titre de la demande de tirage, la description de la demande de tirage, le nom de la branche ou le message de validation.

L'identifiant de la tâche doit être formaté en utilisant l'une de ces options :

#{task_id}[statut]

CU-{task_id}[status]

{custom_task_id}[statut]

#{custom_task_id}[statut]

Pour mettre à jour le statut d’une tâche :

  1. Ajoutez l'identifiant de tâche ClickUp dans n'importe quelle partie du message de validation ou de demande de tirage.
  2. Incluez le statut de la tâche mis à jour entre crochets.

Par exemple : #ud5b[prêt]

Tous les formats listés dans la section Lier les tâches depuis GitHub de cet article peuvent être utilisés. Pour garantir un formatage approprié, ne rajoutez pas d'espace entre l'identifiant de tâche et les informations de statut.

Vous pouvez également mettre à jour les statuts des tâches en utilisant les Automatisations GitHub!

Gérez les problèmes, les branches, les demandes de tirage et les validations GitHub depuis ClickUp

Après avoir lié des problèmes, des branches, des demandes de tirage ou des validations, ils s'affichent sur le côté droit de votre tâche lorsque vous cliquez sur l'icône GitHub. Utilisez le menu points de suspension ... pour copier le lien ou supprimer l'élément.

Si vous avez rejoint l'environnement de travail en tant qu'invité, vous ne pourrez pas utiliser l'intégration GitHub. Contactez le propriétaire de votre environnement de travail ou l'administrateur pour demander une mise à niveau vers membre de l'environnement de travail.

Une fois qu'un élément GitHub est lié, les informations suivantes sont affichées dans votre tâche ClickUp :

Informations sur le problème

Après qu'un problème soit lié, vous pouvez voir les détails suivants :

  • La personne qui a ouvert le problème, connue sous le nom d'auteur
  • Tout examinateur assigné
  • Lien créé
  • Référentiel
  • Le statut du problème.
  • URL

Informations sur la branche

Une fois une branche liée, vous pouvez voir les détails suivants :

  • La personne qui a créé la branche, connue sous le nom de l'auteur
  • Créateur de lien
  • Référentiel
  • URL

Informations sur la demande de tirage

Après qu'une demande de tirage soit liée, vous pouvez voir les détails suivants :

  • La personne qui a ouvert la demande de tirage, connue sous le nom d'auteur
  • Tout examinateur assigné
  • Personnes assignées
  • Modifications de ligne
  • Lien créé
  • Référentiel
  • Branche source
  • Branche cible
  • La demande de tirage statut
  • URL

Informations sur la validation

Une fois une validation liée, vous pouvez voir les détails suivants :

  • La personne qui a créé la validation, connue sous le nom de l'auteur
  • Fichiers modifiés
  • Modifications de ligne
  • Lien créé
  • Référentiel
  • URL

Ajoutez votre compte GitHub à ClickUp

Les membres de l'environnement de travail peuvent lier leurs comptes GitHub à leur compte ClickUp à l'avance ou lorsqu'ils créent une branche ou une demande de tirage.

Pour ajouter votre compte GitHub depuis le Centre d’applications :

  1. Recherchez et sélectionnez GitHub.
  2. Cliquez sur l'onglet Personnel.
  3. À côté de Créer une connexion personnelle, cliquez sur Connecter.
  4. Connectez-vous à GitHub et autorisez ClickUp.

Problèmes de connexion

Parfois, le mauvais compte GitHub est lié ou il y a un problème de connexion. Dans ce scénario, vous pouvez essayer de déconnecter et de reconnecter vos référentiels ou votre compte entier.

Ces actions n'affectent pas la capacité de quiconque à accéder aux dépôts en utilisant leur compte GitHub via GitHub.

Pour déconnecter un référentiel :

  1. Depuis le Centre d'applications, sélectionnez GitHub.
  2. Dans le coin supérieur droit, cliquez sur Paramètres de l'environnement de travail.
  3. Sous Référentiels, cliquez sur le menu ellipsis ... à droite du référentiel.
  4. Cliquez sur Supprimer de ClickUp.

La section ci-dessous comprend des instructions pour déconnecter votre compte entier.

Déconnecter l'intégration GitHub

Si vous n'avez plus besoin d'accéder aux fichiers GitHub dans ClickUp, vous pouvez déconnecter l'intégration depuis le Centre d'applications :

  1. Recherchez et sélectionnez GitHub.
  2. Sélectionnez l'onglet Environnement de travail.

    Seuls les propriétaires et les administrateurs peuvent déconnecter les connexions de l'environnement de travail.

  3. À côté de Connecté, cliquez sur le menu points de suspension ....
  4. Sélectionnez Déconnecter.
  5. Pour confirmer, cliquez sur Déconnecter.

Cet article vous a-t-il été utile ?