Remarque
Bien que la gemme github-pages soit toujours pris en charge pour certains workflows, GitHub Actions est désormais l'approche recommandée pour déployer et automatiser les sites GitHub Pages.
À propos des erreurs de compilation Jekyll
Si vous publiez à partir d’une branche, il arrive parfois que GitHub Pages ne tente pas de créer votre site après que vous avez poussé des modifications vers la source de publication de votre site.
- Vous poussez avec une clé de déploiement. Si vous souhaitez automatiser les poussées vers le dépôt de votre site, vous pouvez configurer un utilisateur d’ordinateur à la place. Pour plus d’informations, consultez « Gestion des clés de déploiement ».
- Vous utilisez un service CI qui n’est pas configuré pour générer votre source de publication. Par exemple, Travis CI ne génère pas la branche
gh-pages, sauf si vous ajoutez la branche à une liste sécurisée. Pour plus d’informations, consultez Personnalisation du build sur Travis CI ou la documentation de votre service CI.
Remarque
La publication des modifications apportées à votre site peut prendre jusqu’à 10 minutes après avoir envoyé les modifications GitHub.
Si Jekyll tente de générer votre site et rencontre une erreur, vous recevrez un message d’erreur de génération. Il existe deux principaux types de messages d’erreur de build Jekyll.
- Un message « Avertissement de construction de page » signifie que votre build s’est terminé correctement, mais vous devrez peut-être apporter des modifications pour éviter de futurs problèmes.
- Un message « Échec de génération de page » signifie que votre build a échoué. Si Jekyll est en mesure de détecter une raison de l’échec, un message d’erreur descriptif s’affiche.
Pour plus d’informations sur la résolution des erreurs de build, consultez Dépannage des erreurs de build Jekyll pour les sites GitHub Pages.
Consulter les échecs de compilation de votre dépôt sur GitHub
Vous pouvez voir les échecs de compilation (mais pas les avertissements de compilation) pour votre site dans l'onglet Paramètres du référentiel de votre site.
Affichage des messages d’erreur de compilation Jekyll en local
Nous vous recommandons de tester votre site localement, ce qui vous permettra de voir les messages d’erreur de génération sur la ligne de commande et de corriger tout échec de génération avant d’envoyer vos modifications vers GitHub. Pour plus d’informations, consultez « Test de votre site GitHub Pages localement avec Jekyll ».
Affichage des messages d’erreur de build Jekyll dans votre pull request
Si vous publiez à partir d’une branche, lorsque vous créez une pull request sur GitHub pour mettre à jour votre source de publication, vous pouvez consulter les messages d’erreur de génération dans l’onglet Vérifications de la pull request. Pour plus d’informations, consultez « À propos des vérifications d’état ».
Si vous publiez avec un workflow personnalisé GitHub Actions, pour voir les messages d’erreur de génération dans votre pull request, vous devez configurer votre workflow pour qu’il s’exécute avec le déclencheur pull_request. Lorsque vous effectuez cette opération, nous vous recommandons d’ignorer les étapes de déploiement si le workflow a été déclenché par l’événement pull_request. Cela vous permet de voir les erreurs de build sans déployer les modifications de votre demande de tirage sur votre site. Pour plus d’informations, consultez « Événements qui déclenchent des flux de travail » et « Évaluer des expressions dans les workflows et les actions. ».
Affichage des erreurs de build Jekyll par e-mail
Si vous publiez à partir d’une branche, lorsque vous poussez vos modifications vers votre source de publication sur GitHub, GitHub Pages tentera de générer votre site. Si la compilation échoue, vous recevrez un courriel à votre adresse de courriel principale.
Conseil
Vous ne recevrez qu’un e-mail si la prise en charge des e-mails sortants est activée dans votre instance GitHub Enterprise Server. Pour plus d’informations, contactez votre administrateur de site.
Si vous publiez avec un workflow personnalisé GitHub Actions, afin de recevoir des e-mails concernant les erreurs de build dans votre pull request, vous devez configurer votre workflow pour qu’il s’exécute avec le déclencheur pull_request. Lorsque vous effectuez cette opération, nous vous recommandons d’ignorer les étapes de déploiement si le workflow a été déclenché par l’événement pull_request. Cela vous permet de voir les erreurs de build sans déployer les modifications de votre demande de tirage sur votre site. Pour plus d’informations, consultez « Événements qui déclenchent des flux de travail » et « Évaluer des expressions dans les workflows et les actions. ».
Affichage des messages d’erreur de compilation Jekyll dans votre pull request avec un service d'intégration continue (CI) tiers
Vous pouvez configurer un service tiers, tel que Travis CI, pour afficher les messages d’erreur après chaque commit.
-
Si ce n’est déjà fait, ajoutez un fichier appelé Gemfile à la racine de votre source de publication, avec le contenu suivant :
source `https://rubygems.org` gem `github-pages` -
Configurez le dépôt de votre site pour le service de test de votre choix. Par exemple, pour utiliser Travis CI, ajoutez un fichier appelé .travis.yml à la racine de votre source de publication, avec le contenu suivant :
language: ruby rvm: - 2.3 script: "bundle exec jekyll build" -
Vous devrez peut-être activer votre dépôt avec le service de test tiers. Pour plus d’informations, consultez la documentation de votre service de test.