Recherchez des fichiers GitHub depuis ClickUp, synchronisez l'activité GitHub avec les tâches ClickUp, créez des pull requests, des branches et des issues GitHub depuis ClickUp, et bien plus encore.

Lors de la configuration de l'intégration, vous lierez des Espaces directement à des dépôts GitHub pour toujours savoir quel travail y est associé.

Les propriétaires et administrateurs d'Environnement de travail peuvent connecter des Espaces à leurs dépôts, ce qui permet aux membres d'ajouter leur travail GitHub à leurs tâches.

Les tâches dans des Espaces connectés à un dépôt peuvent être liées à des commits, des branches et des pull requests.

Ce dont vous aurez besoin

• L'intégration GitHub est disponible sur tous les abonnements ClickUp.
• Seuls les administrateurs de dépôt peuvent ajouter des dépôts GitHub à ClickUp. Une fois ajoutés, les administrateurs d'Environnement de travail peuvent ajouter ces dépôts aux Espaces ClickUp !
• Seuls les propriétaires et administrateurs d'Environnement de travail peuvent modifier les paramètres de l'Environnement de travail depuis l'App Center.
• Seuls les propriétaires et administrateurs d'Environnement de travail peuvent ajouter des dépôts et les lier à des Espaces.
• Seuls les propriétaires et administrateurs d'Environnement de travail peuvent créer des connexions d'Environnement de travail. Plusieurs connexions d'Environnement de travail sont autorisées.
• Les membres et niveaux supérieurs peuvent créer des connexions personnelles.
• Les invités et les membres limités ne peuvent pas utiliser l'intégration GitHub.

Types de connexion

Les fonctionnalités et commandes disponibles dépendent du type de connexion que vous utilisez.

Configurer une connexion personnelle

Pour configurer une connexion personnelle avec GitHub :

1. En haut à gauche, cliquez sur l'avatar de votre Environnement de travail et sélectionnez Applications.
2. Recherchez et sélectionnez GitHub.
3. Cliquez sur Connecter.
4. Suivez les instructions pour autoriser ClickUp, puis cliquez sur Terminé.

Configurer une connexion d'Environnement de travail

La configuration d'une connexion d'Environnement de travail pour GitHub dans ClickUp comporte trois étapes :

1. Connecter GitHub.
2. Associer des dépôts GitHub à votre Environnement de travail. Les dépôts sont nécessaires pour que ClickUp puisse lier automatiquement les pull requests à leurs tâches ClickUp respectives.
3. Lier des dépôts GitHub à des Espaces ClickUp.

Étape 1 : connecter GitHub

Pour configurer une connexion d'Environnement de travail pour GitHub :

1. Dans le coin supérieur gauche, cliquez sur l'avatar de votre Environnement de travail et sélectionnez Applications.
2. Recherchez et sélectionnez GitHub.
3. En haut, cliquez sur l'onglet Environnement de travail.
   • Facultatif : désactivez la recherche connectée de l'Environnement de travail en cliquant sur le bouton bascule correspondant.
4. Cliquez sur Connecter.
5. Suivez les instructions pour autoriser ClickUp.
6. Choisissez les dépôts à rendre consultables via la recherche connectée de l'Environnement de travail en cliquant sur le menu déroulant Sélectionner des dépôts.
7. Une fois les dépôts ajoutés, cliquez sur Enregistrer.

   

8. Cliquez sur Suivant, puis sélectionnez Terminé.

Étape 2 : ajouter des dépôts GitHub à votre Environnement de travail

Seul le propriétaire de la connexion peut ajouter des dépôts.

Associer un dépôt ne donne pas aux utilisateurs ClickUp accès à la base de code de votre dépôt.

Pour ajouter un dépôt à votre Environnement de travail :

1. Depuis la page GitHub dans l'App Center, cliquez sur Paramètres en haut à droite.
2. Cliquez sur Ajouter un dépôt.
3. Sélectionnez un dépôt.
4. Pour ajouter d'autres dépôts, répétez les étapes 2 et 3.

Si vous ne voyez pas les bons dépôts, vérifiez que vous êtes connecté au bon compte. Un propriétaire ou un administrateur de l'Environnement de travail doit sélectionner chaque dépôt à connecter. Les dépôts liés sont consultables dans l'App Center.

Étape 3 : lier des dépôts GitHub à des Espaces ClickUp

Après avoir ajouté des dépôts à votre Environnement de travail, les administrateurs peuvent connecter chaque dépôt à un ou plusieurs Espaces. Plusieurs dépôts peuvent être ajoutés à un même Espace.

Pour lier un dépôt à un Espace :

1. Depuis la page GitHub dans l'App Center, cliquez sur Paramètres en haut à droite.
2. Cliquez sur le nom du dépôt que vous souhaitez lier.
3. Cliquez sur + Ajouter un Espace.

   

4. Recherchez un Espace et sélectionnez-le.
5. Pour lier des Espaces supplémentaires, répétez les étapes 2 à 4.

Modifier le format du 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 l'App Center. Quand des membres créent des branches à partir de tâches ClickUp, ce format est appliqué.

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

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

Les valeurs disponibles sont présentées dans le tableau suivant :

Pour modifier le format du nom de votre branche :

1. Depuis la page GitHub dans l'App Center, cliquez sur Paramètres en haut à droite.
2. Sous Nom de branche généré automatiquement, saisissez le format de nom de branche souhaité.
3. Cliquez sur Enregistrer.

Rechercher des fichiers GitHub via 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 n'importe quel fichier public dans les dépôts que vous ajoutez.

Modifier les dépôts consultables

Pour modifier les dépôts pouvant être consultés via la recherche connectée de l'Environnement de travail :

1. Depuis la page GitHub dans l'App Center, cliquez sur l'onglet Environnement de travail.
2. Ajoutez des dépôts à la recherche connectée de l'Environnement de travail ou supprimez-en :
   • Ajouter de nouveaux dépôts : cliquez sur le menu déroulant dépôts sélectionnés et sélectionnez un dépôt.
   • Supprimer un dépôt existant : à droite du dépôt, cliquez sur l'icône x.

Autoriser les Super Agents à effectuer des recherches dans GitHub

Pour autoriser un Super Agent à rechercher des fichiers dans votre compte GitHub connecté, activez la recherche externe pour GitHub dans son profil.

Lier des tâches depuis GitHub

ClickUp associe automatiquement les nouvelles activités GitHub aux tâches si vous incluez un identifiant de tâche ClickUp valide dans le titre de la pull request, la description de la pull request, le nom de la branche ou le message de commit.

Lorsqu'un identifiant de tâche ClickUp est inclus dans une pull request, un commentaire contenant un lien vers la tâche ClickUp est publié dans la pull request. En revanche, aucun lien ne s'affiche si vous collez manuellement une pull request dans une tâche ClickUp.

Le commentaire est publié via le compte GitHub de la personne qui a configuré le dépôt et la correspondance avec l'Espace.

L'identifiant de tâche doit être formaté selon l'une des options suivantes :

#{task_id}

CU-{task_id}

{custom_task_id}

#{custom_task_id}

Par exemple :

#1abc2de

CU-1abc2de

eng-123

#eng-123

Lier des tâches depuis ClickUp

Liez manuellement des tâches ClickUp à des commits, des branches et des pull requests GitHub depuis la tâche. Vérifiez que la tâche se trouve dans un Espace lié à un dépôt.

Pour lier une tâche :

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

   

2. Dans le coin inférieur droit, cliquez sur Ajouter un lien GitHub.
3. Collez un lien.
4. Dans le coin inférieur droit, cliquez sur Ajouter.

Activité de la tâche ClickUp

L'activité GitHub est accessible depuis le fil d'Activité de la tâche ClickUp liée.

Les fils d'activité des tâches regroupent parfois des éléments d'activité similaires pour vous afficher les informations les plus importantes.

Vous pouvez effectuer les actions suivantes pour retrouver l'activité GitHub dans une tâche :

• Cliquez sur Afficher plus pour afficher l'activité masquée.

  

• Lorsqu'une branche est fusionnée, les commits apparaissent sous forme d'un seul élément d'activité dans le fil d'activité de la tâche.
  • Cliquez sur le lien vers tous les commits pour ouvrir une fenêtre modale.
  • Cliquez sur un commit pour l'ouvrir dans GitHub.
• Filtrez l'activité de la tâche par éléments Git.

  

Activité manquante

Si vous ne trouvez pas certaines activités, vérifiez que vous référencez correctement l'identifiant de tâche ClickUp pour associer l'activité dans GitHub. Vous pouvez utiliser l'une des trois options suivantes pour référencer vos tâches ClickUp dans les commits, les noms de branche et les pull requests :

#{task_id}

CU-{task_id}

{custom_task_id}

Par exemple :

#1abc2de

CU-1abc2de

prefix-1

Vous pouvez également lier manuellement des tâches ClickUp à des commits, des branches et des pull requests GitHub depuis la tâche ClickUp.

Aperçus des liens GitHub

Lorsque vous collez un lien GitHub au milieu d'une phrase ou dans du texte existant, un aperçu de lien intégré s'affiche. Passez la souris dessus pour obtenir plus de détails.

Lorsque vous collez un lien GitHub sur une nouvelle ligne, vous pouvez choisir de l'afficher de façon intégrée, sous forme d'aperçu en direct ou en tant qu'URL classique.

Les aperçus de liens fonctionnent dans les descriptions de tâches, les commentaires, les Documents et les messages de Discussion. Pour modifier manuellement le type d'aperçu d'un lien, passez la souris dessus et cliquez sur l'icône points de suspension ….

Créer des issues, des branches et des pull requests GitHub depuis ClickUp

Créez de nouvelles issues, branches et pull requests directement depuis vos tâches.

Vérifiez que la tâche se trouve dans un Espace lié à un dépôt et que vous avez une connexion personnelle configurée.

Pour créer une issue, une branche ou une pull request :

1. Ouvrez une tâche et cliquez sur l'icône GitHub. Sur la droite, vous verrez des suggestions de noms de branches et de messages de commit que vous pouvez copier dans votre presse-papiers. Vous pouvez également copier l'identifiant de la tâche depuis cet emplacement.
2. Dans le coin inférieur droit, cliquez sur Add GitHub link.
3. Choisissez l'une des options suivantes :
   • New GitHub Issue
   • New GitHub Branch
   • New GitHub Pull Request
4. Nommez l'issue, la branche ou la pull request.
5. Sélectionnez un dépôt et renseignez les informations. Ajoutez une branche source et une branche cible si nécessaire.

   

6. Cliquez sur Create.

Panneau GitHub dans les tâches

Les tâches dans des Espaces liés à des dépôts ont une icône GitHub sur laquelle vous pouvez cliquer pour voir tous les liens GitHub publiés dans la tâche.

L'activité GitHub dans les tâches affiche 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 un commit, poussez un commit ou créez une pull request. ClickUp détecte automatiquement la nouvelle activité GitHub et l'associe aux tâches si vous incluez un identifiant de tâche valide dans le titre de la pull request, sa description, le nom de la branche ou le message de commit.

L'identifiant de la tâche doit être formaté selon l'une des options suivantes :

#{task_id}[status]

CU-{task_id}[status]

{custom_task_id}[status]

#{custom_task_id}[status]

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 commit ou de pull request.
2. Indiquez le nouveau statut de la tâche entre crochets.

Par exemple : #ud5b[ready]

Tous les formats présentés dans la section Lier des tâches depuis GitHub de cet article peuvent être utilisés. Pour garantir un formatage correct, n'ajoutez pas d'espace entre l'identifiant de la tâche et le statut.

Vous pouvez également mettre à jour les statuts des tâches grâce aux automatisations GitHub !

Gérer les issues, branches, pull requests et commits GitHub depuis ClickUp

Une fois que vous avez lié des issues, des branches, des pull requests ou des commits, ils s'affichent lorsque vous cliquez sur l'icône GitHub dans une tâche. 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 s'affichent dans votre tâche ClickUp :

Informations sur l'issue

Une fois une issue liée, vous pouvez consulter les détails suivants :

• La personne qui a ouvert l'issue, appelée l'auteur
• Les réviseurs assignés, s'il y en a
• Lien créé
• Dépôt
• Le statut de l'issue
• URL

Informations sur la branche

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

• La personne qui a créé la branche, appelée l'auteur
• Créateur du lien
• Dépôt
• URL

Informations sur la pull request

Une fois une pull request liée, vous pouvez consulter les détails suivants :

• La personne qui a ouvert la pull request, appelée l'auteur
• Les réviseurs assignés, s'il y en a
• Personnes assignées
• Modifications de lignes
• Lien créé
• Dépôt
• Branche source
• Branche cible
• Le statut de la pull request
• URL

Informations sur le commit

Une fois un commit lié, vous pouvez consulter les détails suivants :

• La personne qui a créé le commit, appelée l'auteur
• Fichiers modifiés
• Modifications de lignes
• Lien créé
• Dépôt
• URL

Afficher les pull requests dans la vue Liste ou Tableau

Ajoutez la colonne Pull Requests à n'importe quelle vue Liste ou vue Tableau pour consulter rapidement vos pull requests GitHub en un coup d'œil.

Problèmes de connexion

Il arrive que le mauvais compte GitHub soit lié ou qu'un problème survienne avec la connexion. Dans ce cas, vous pouvez essayer de déconnecter et de reconnecter vos dépôts ou l'intégralité de votre compte.

Ces actions n'ont aucune incidence sur la capacité des utilisateurs à accéder aux dépôts via leur compte GitHub sur GitHub.

Pour déconnecter un dépôt :

1. Dans l'App Center, sélectionnez GitHub.
2. Dans le coin supérieur droit, cliquez sur Settings.
3. À droite du dépôt, cliquez sur l'icône points de suspension ....
4. Cliquez sur Delete from ClickUp.

Déconnecter GitHub de ClickUp

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

1. Dans l'App Center, sélectionnez GitHub.
2. Sélectionnez l'onglet Environnement de travail. Seuls les propriétaires et les administrateurs peuvent déconnecter les connexions Environnement de travail.
3. À côté de Connected, cliquez sur le menu points de suspension ....
4. Sélectionnez Disconnect.
5. Pour confirmer, cliquez sur Disconnect.

Portées OAuth

Voici un tableau de toutes les portées OAuth de l'intégration GitHub pour vous aider à prendre des décisions éclairées en matière de sécurité et de conformité avant de l'activer dans votre Environnement de travail.