Configuration de l’intégration GitHub avec votre thème Guide

Accès rapide : Guide Admin > Icône Panneau de personnalisation > Ajouter un thème > Ajouter à partir de GitHub

L’intégration GitHub vous permet de développer et maintenir un thème de façon collaborative dans GitHub, puis d’en afficher l’aperçu et de le publier dans Guide. Pour configurer l’intégration, vérifiez que votre thème est stocké dans GitHub, puis configurez l’intégration dans Guide.

Remarque – L’intégration GitHub avec Guide ne prend pas en charge GitHub Enterprise. Utilisez plutôt l’API Thèmes de Guide.

Vous devez être un administrateur Guide pour configurer l’intégration GitHub dans Guide.

Cet article aborde les sujets suivants :

• Préparation de votre thème dans GitHub
• Configuration de l’intégration

Préparation de votre thème dans GitHub

Vous devez vérifier que votre thème se trouve dans GitHub avant de configurer l’intégration dans Guide. Si vous utilisez Git et GitHub pour la première fois, consultez ce didacticiel. Si votre thème se trouve déjà dans GitHub et s’il satisfait aux exigences suivantes, consultez Configuration de l’intégration dans Guide.

L’intégration a les exigences suivantes pour votre référentiel GitHub :

• Le fichier de manifeste doit être à la racine du référentiel GitHub.

  Le fichier manifest.json doit être placé à la racine du référentiel GitHub pour Guide pour que l’ajout de votre thème soit possible. Vous pouvez encore inclure d’autres fichiers, qui sont ignorés lors de l’importation dans Guide.

• Le référentiel GitHub ne peut contenir qu’un seul thème.

  Vous devez gérer un seul thème dans chaque référentiel. Vous pouvez utiliser l’option de branche pendant l’importation du thème pour essayer des variantes de votre thème.

Pour placer votre thème dans un référentiel GitHub

• Si vous n’avez actuellement aucun thème, utilisez le référentiel du thème Copenhagen et commencez à créer votre thème. Cela vous permettra de facilement porter les améliorations du thème Copenhagen vers votre thème ultérieurement.
• S’il est dans Guide, téléchargez votre thème à partir de Guide, puis créez un référentiel GitHub (si vous n’en avez pas) et transférez votre thème dans ce référentiel GitHub.
• Si votre thème n’est ni dans Guide ni dans GitHub, créez un référentiel GitHub (si vous n’en avez pas) et transférez votre thème dans ce référentiel GitHub.

Une fois que vous avez préparé votre thème dans GitHub, vous êtes prêt à configurer l’intégration dans Guide.

Configuration de l’intégration

Pour configurer l’intégration GitHub, vous devez vérifier que votre thème est stocké dans GitHub, puis récupérer votre thème dans GitHub pour le transférer dans Guide. Cette récupération unique établit la connexion entre votre thème et GitHub.

Une fois l’intégration configurée, vous travaillerez sur le thème dans GitHub, puis le mettrez à jour dans Guide quand vous serez prêt. Vous pourrez alors afficher un aperçu ou publier votre thème dans Guide.

Pour configurer l’intégration GitHub avec votre thème Guide

1. Dans GitHub, vérifiez que vous avez bien préparé votre thème.
2. Dans Guide, cliquez sur l’icône du panneau de personnalisation () dans la barre latérale.

   La page Thèmes s’ouvre.

3. Cliquez sur Ajouter un thème dans le coin supérieur droit.
4. Cliquez sur Ajouter à partir de GitHub.

   

5. Saisissez l’URL du référentiel puis, facultativement, saisissez un nom de branche si vous voulez effectuer la récupération à partir d’une branche autre que la branche par défaut, et enfin cliquez sur Importer.
6. Connectez-vous à GitHub si vous y êtes invité, puis cliquez sur Authorize Zendesk.

La vignette du thème s’affiche sur la page Thèmes une fois l’importation terminée. Si vous avez des difficultés, consultez Dépannage de l’intégration GitHub pour les thèmes Guide.

Une fois que vous avez établi la connexion entre votre thème dans Guide et GitHub, la gestion de votre thème se fait dans GitHub et sa mise à jour dans Guide.