Vous devez être connecté à votre espace de travail Ferndesk avant de connecter une intégration. Assurez-vous d’être connecté et d’être dans la bonne organisation. Si vous avez accès à plusieurs espaces de travail Ferndesk, passez à celui dans lequel vous souhaitez ajouter la connexion GitHub.
Intégration GitHub
Connectez votre compte GitHub à Ferndesk afin que Fern puisse parcourir votre base de code et comprendre le fonctionnement des fonctionnalités, ce qui aide à générer des articles de centre d’aide plus précis et plus pertinents.
Vous avez besoin d’un compte GitHub pour terminer cette intégration. Si vous n’en avez pas, créez-en un sur le site web GitHub.
Connecter GitHub
Depuis votre tableau de bord Ferndesk, cliquez sur Integrations dans la barre latérale.
Repérez la carte GitHub et cliquez sur Connect.
Vous serez redirigé vers GitHub pour autoriser la connexion. Connectez-vous à votre compte GitHub si vous n’êtes pas déjà connecté.
Accordez à Ferndesk l’autorisation d’accéder à votre compte GitHub. Vous pouvez sélectionner les dépôts à connecter. Vous pouvez choisir plusieurs dépôts si votre projet s’étend sur plusieurs repos, par exemple un backend et un tableau de bord dans des dépôts distincts.
Après autorisation, vous serez redirigé vers Ferndesk. L’intégration GitHub apparaîtra comme connectée.
Une fois connecté, Fern peut parcourir votre base de code pour fournir des articles de centre d’aide plus précis et plus pertinents.
Gérer les dépôts connectés
Après la configuration initiale, vous pouvez ajouter ou supprimer des dépôts en accédant aux paramètres de votre application GitHub. Allez dans les paramètres de votre compte GitHub, ouvrez Applications et trouvez Ferndesk dans vos intégrations installées pour ajuster l’accès aux dépôts.
Portée du dépôt et de la branche
Lorsque Fern parcourt votre base de code, il peut cibler un dépôt ou une branche spécifique de votre compte GitHub connecté au lieu de s’appuyer uniquement sur le dépôt par défaut.
Si vous avez plusieurs dépôts connectés, Fern peut se concentrer sur le repo pertinent pendant l’analyse. Pour un travail spécifique à une branche, comme la revue d’une fonctionnalité non encore publiée ou d’une pull request, Fern peut également parcourir une branche spécifique lorsqu’elle est fournie.
Vous pouvez également définir une branche de production pour chaque dépôt afin que Fern sache quelle branche représente votre code en production. Voir Set a production branch ci-dessous.
Pour permettre à Fern de parcourir un dépôt, assurez-vous qu’il est connecté dans votre intégration GitHub. Allez dans les paramètres de votre compte GitHub, ouvrez Applications et trouvez Ferndesk pour ajouter ou supprimer l’accès aux dépôts.
Définir une branche de production
Définissez une branche de production pour chaque dépôt connecté afin que Fern sache quelle branche représente votre code en production. Sans cela, Fern utilise la branche par défaut du dépôt. Chaque dépôt peut utiliser une branche différente.
Choisir une branche de production
Ouvrez Integrations depuis la barre latérale du tableau de bord et sélectionnez votre connexion GitHub.
Repérez la carte Production branches sur la page de détails de la connexion.
Trouvez le dépôt que vous souhaitez configurer. Utilisez le champ de recherche si vous avez de nombreux dépôts.
Cliquez sur le sélecteur de branche de ce dépôt, puis recherchez une branche ou choisissez-en une dans la liste.
Revenir à la branche par défaut
Ouvrez le sélecteur de branche et choisissez Use default branch. Fern recommence à utiliser la branche par défaut du dépôt.
Lorsque vous demandez à Fern d’examiner une branche spécifique, comme une branche de pull request, cette demande prime sur le paramètre de branche de production.
Lorsqu’une branche configurée n’existe plus
Si une branche de production est supprimée ou renommée sur GitHub, la carte Production branches indique que la branche n’existe plus. Choisissez une autre branche ou sélectionnez Use default branch pour reprendre.
Lorsque GitHub informe Ferndesk qu’une branche a été supprimée, Fern supprime le paramètre et revient à la branche par défaut. Cela nécessite que l’application GitHub soit abonnée aux événements Delete.
Dépannage
Je vois « Authentication required to connect GitHub »
Je vois « GitHub OAuth organization does not match the active session »
Le compte ou l’organisation GitHub que vous autorisez appartient à une organisation différente de celle à laquelle vous êtes connecté dans Ferndesk. Assurez-vous de :
Être connecté au bon espace de travail Ferndesk
Autoriser le compte ou l’organisation GitHub correspondant à cette organisation Ferndesk
Si vous devez connecter une autre organisation GitHub à un autre espace de travail Ferndesk, passez d’abord à cet espace de travail dans Ferndesk, puis connectez GitHub.
La page d’autorisation GitHub affiche une erreur
Cela peut se produire si :
Votre session a expiré. Essayez de vous déconnecter de Ferndesk puis de vous reconnecter.
L’état OAuth est devenu invalide. Fermez la fenêtre d’autorisation et cliquez à nouveau sur Connect dans Ferndesk.
Ressources supplémentaires
Pour plus d’informations sur les fonctionnalités GitHub, consultez la documentation GitHub.