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.
  • La Recherche connectée de l'environnement de travail est disponible sur le forfait Business et supérieurs.

  • Personal Connected Search n’est pas disponible pour l’intégration GitHub.

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.
  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

Vous devez être propriétaire ou administrateur de l'environnement de travail pour configurer une connexion d'environnement de travail pour GitHub.

Vous pouvez configurer une connexion GitHub depuis le Centre d'applications ou le centre de commande.

Depuis le Centre d’application :

  1. Recherchez et sélectionnez GitHub.
  2. Cliquez sur l'onglet environnement de travail.

    Vous pouvez également configurer une connexion personnelle pour créer des demandes de tirage et des branches depuis ClickUp. Les connexions personnelles peuvent également être utilisées pour lier directement des demandes de tirage, des branches et des validations existantes depuis les tâches ClickUp. 

  3. Cliquez sur Connecter.
  4. Connectez-vous à votre compte GitHub pour autoriser l'accès.

Capture d'écran du bouton Autoriser ClickUp lors de la configuration de l'intégration.

Depuis le centre de commande :

  1. Sous la barre de recherche, cliquez sur Applications.
  2. Sous GitHub, cliquez sur Connecter.
  3. Sous Connexions d'environnement de travail, cliquez sur Connecter.
  4. Connectez-vous à votre compte GitHub pour autoriser l'accès.

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

Les propriétaires et administrateurs d'environnement de travail peuvent choisir quels référentiels GitHub lier à leur environnement de travail ClickUp. Le propriétaire ou l'administrateur doit également être un administrateur de référentiel GitHub.

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. Ouvrez GitHub dans le Centre d'applications.
  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, vous vous êtes peut-être connecté avec le mauvais compte GitHub.

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

Après avoir ajouté des référentiels à votre environnement de travail, vous pouvez ajouter chaque référentiel à un ou plusieurs Espaces. Plusieurs référentiels peuvent être ajoutés à chaque espace ClickUp.

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

Lors de l'utilisation d'une connexion d'environnement de travail sur le forfait Business et supérieur, vous pouvez utiliser la Recherche Connectée de l'environnement de travail pour permettre à tous les membres de l'environnement de travail de rechercher des fichiers publics des référentiels que vous ajoutez. Les fichiers privés ne peuvent pas être recherchés.

Depuis le Centre d’applications :

  1. Recherchez et sélectionnez GitHub.
  2. Cliquez sur l'onglet Environnement de travail.
  3. Cliquez sur le bouton à côté de Recherche connectée dans l’environnement de travail.
  4. À côté de votre connexion à l'environnement de travail, cliquez sur Enregistrer.
  5. Les fichiers GitHub dans les référentiels que vous avez ajoutés s'afficheront lors de la recherche dans votre environnement de travail.

Épingler GitHub au centre de contrôle

Filtrez les résultats de recherche pour les fichiers GitHub en épinglant GitHub au centre de contrôle de mission.

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.

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.

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.

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 ?